Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Product

View purchase orders positions

Returns a list of given Products' positions in PurchaseOrders

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

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' | 'deliveryDate' | 'order' | 'orderDate' | 'orderNumber' | 'supplier' | 'supplierName'
dir'asc' | 'desc'

Response

Success

Example response

{
  "data": [
    {
      "id": "17",
      "number": "12345-XYZ",
      "date": "2024-09-19T12:34:56Z",
      "amount": "25.00",
      "deliveredAmount": "15.50",
      "deliveryDate": "2024-09-19",
      "isInstantDelivery": true,
      "purchaseOrder": {
        "id": "PO123456",
        "number": "ORD-2024-001",
        "deliveryDate": "2024-10-15",
        "supplier": {
          "id": "SUP123",
          "name": "Test Supplies Inc."
        }
      }
    }
  ],
  "extra": {
    "page": {
      "number": 1,
      "size": 10
    }
  }
}