v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

Product

List parts

Returns a list of given Products' Parts

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

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'product' | 'productName' | 'amount'

dir'asc' | 'desc'

Response

Success

Example response

{
  "data": [
    {
      "id": "17",
      "amount": "25.00",
      "product": {
        "id": "1",
        "name": "Product Name",
        "number": "SKU123456"
      },
      "reference": "REF-12345",
      "type": "provision",
      "createdAt": "2021-12-15T11:31:44+01:00",
      "updatedAt": "2022-12-15T11:31:44+01:00"
    }
  ],
  "extra": {
    "page": {
      "number": 1,
      "size": 10
    }
  }
}