---
title: "View sales orders positions"
method: GET
path: "/api/v1/products/{id}/salesOrdersPositions"
tags: ["Product"]
---

# View sales orders positions

`GET /api/v1/products/{id}/salesOrdersPositions`

## Request

- Base URL: `https://xentral.xentral.biz`
- URL: `https://xentral.xentral.biz/api/v1/products/{id}/salesOrdersPositions`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/xentral/apis/xentral-api/docs/api/v1/products/:id/salesOrdersPositions/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of given Products' positions in SalesOrders

## Path parameters

- `id` string, required: Resource identifier.

## Query parameters

- `page` object
  - `number` string, required: Page number should be an integer greater than or equal to 1
  - `size` string, required: Page size should usually be an integer between 10 and 50.
- `order` object[]
  - `field` 'id' | 'amount' | 'customer' | 'customerName' | 'order' | 'orderNumber' | 'orderStatus'
  - `dir` 'asc' | 'desc'

## Response `200`

Success

- object
  - `data` object[]
    - `id` string: Resource identifier.
    - `amount` string, float
    - `desiredDeliveryDate` string, date, nullable: Desired delivery date for the order.
    - `desiredDeliveryDateCw` boolean: Indicates if the desired delivery date is in calendar weeks.
    - `salesOrder` object: Represents a sales order containing details such as order ID, status, date, and customer information.
      - `id` string: Unique identifier for the sales order.
      - `number` string: The order number assigned by the system.
      - `status` string: Current status of the sales order (e.g., 'pending', 'completed', 'canceled').
      - `desiredDeliveryDate` string, date, nullable: Desired delivery date for the order.
      - `desiredDeliveryDateCw` boolean: Indicates if the desired delivery date is in calendar weeks.
      - `reservationDate` string, date, nullable: Date when the order was reserved.
      - `earliestFulfillmentDate` string, date, nullable: Earliest date when the order can be fulfilled.
      - `date` string, date: The date when the sales order was created.
      - `customer` object: Information about the customer associated with the sales order.
        - `id` string: Unique identifier for the customer.
        - `name` string: Name of the customer.
        - `number` string: Customer account number.
        - `date` string, date: Date associated with the customer (e.g., registration date).
  - `extra` object: Pagination data from the current request.
    - `page` object, required: The pagination object containing the current page number and size
      - `number` integer, required
      - `size` integer, required

## Other responses

- `429`: Too many API calls made.

---

[API](https://skmtc.dev/xentral/apis/xentral-api.md) - [All operations](https://skmtc.dev/xentral/apis/xentral-api/llms.txt) - [OpenAPI document](https://skmtc.dev/xentral/apis/xentral-api/revisions/ebe5ba2a4ed8?raw)