Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Product

View sales orders positions

Returns a list of given Products' positions in SalesOrders

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

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' | 'order' | 'orderNumber' | 'orderStatus'
dir'asc' | 'desc'

Response

Success

Example response

{
  "data": [
    {
      "id": "17",
      "amount": "25.00",
      "desiredDeliveryDate": "2024-10-24",
      "salesOrder": {
        "id": "SO987654",
        "number": "ORD-2024-002",
        "status": "pending",
        "desiredDeliveryDate": null,
        "desiredDeliveryDateCw": false,
        "reservationDate": null,
        "earliestFulfillmentDate": "2024-10-05",
        "date": "2024-09-25",
        "customer": {
          "id": "CUST123",
          "name": "John Doe",
          "number": "CUST-001",
          "date": "2022-01-15"
        }
      }
    }
  ],
  "extra": {
    "page": {
      "number": 1,
      "size": 10
    }
  }
}