v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

Product

View reservations

Returns a list of given Products' Reservations

get/api/v1/products/{id}/reservations

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Query parameters

numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

field'id' | 'amount' | 'customer' | 'customerName'

dir'asc' | 'desc'

Response

Success

Example response

{
  "data": [
    {
      "id": "17",
      "amount": "25.00",
      "reason": "Product was damaged upon arrival.",
      "project": {
        "id": "12345",
        "reference": "REF-67890"
      },
      "customer": {
        "id": "12345",
        "name": "John Doe",
        "number": "CUST-001"
      }
    }
  ],
  "extra": {
    "page": {
      "number": 1,
      "size": 10
    }
  }
}