> ## Documentation Index > Fetch the complete documentation index at: https://docs.dekhq.com/llms.txt > Use this file to discover all available pages before exploring further. # Order shipments > Shipments for your orders, with addresses and package tracking. Only orders for the clients your credential is linked to. At most 5,000 orders. ## OpenAPI ````yaml /api/promostandards/openapi.json get /api/partners/v1/orders/shipments openapi: 3.1.0 info: title: DEKHQ Partner REST API version: 1.0.0 description: >- JSON versions of the PromoStandards Order Status and Order Shipment Notification services. Same credentials, scopes and rate limit as the SOAP endpoints. Generated from the dekhq repo; do not edit by hand. servers: - url: https://partners.dekhq.com security: - basicAuth: [] paths: /api/partners/v1/orders/shipments: get: summary: Order shipments description: >- Shipments for your orders, with addresses and package tracking. Only orders for the clients your credential is linked to. At most 5,000 orders. operationId: getOrderShipments parameters: - name: queryType in: query required: true description: >- 1 = PO number, 2 = sales order number, 3 = shipped since `shipmentDateTimeStamp`. Other values return an empty list. schema: type: integer enum: - 1 - 2 - 3 - name: referenceNumber in: query required: false description: PO number (queryType 1) or sales order number (queryType 2). schema: type: string - name: shipmentDateTimeStamp in: query required: false description: ISO 8601 time; queryType 3 returns shipments since then. schema: type: string format: date-time responses: '200': description: Matching shipments. content: application/json: schema: type: object properties: shipments: type: array items: $ref: '#/components/schemas/OsnEntry' required: - shipments additionalProperties: false example: shipments: - purchaseOrderNumber: PO-10042 complete: true salesOrders: - salesOrderNumber: SO-58817 complete: true locations: - id: 1 complete: true shipFromAddress: address1: 100 Example Ave city: Springfield region: IL postalCode: '62701' country: US shipToAddress: address1: 200 Sample St address2: Suite 300 city: Riverton region: WY postalCode: '82501' country: US packages: - id: 1 trackingNumber: 1Z999AA10123456784 shipmentDate: '2026-02-12T18:00:00Z' carrier: UPS shipmentMethod: Ground weight: 12.5 weightUOM: Pounds '401': description: Missing or invalid credentials. headers: WWW-Authenticate: schema: type: string description: Basic realm="DEKHQ Partner API" content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Invalid id or password '403': description: Credential not enabled for this service. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: 'Credential not permitted for scope: order_status' '429': description: More than the allowed requests per minute. headers: Retry-After: schema: type: integer description: Seconds to wait before retrying. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Rate limit exceeded '500': description: Unexpected error on our side; retry later. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Internal error components: schemas: OsnEntry: type: object properties: purchaseOrderNumber: type: string description: Your purchase order number. complete: type: boolean description: All shipments for this purchase order are complete. salesOrders: type: array items: $ref: '#/components/schemas/OsnSalesOrder' required: - purchaseOrderNumber - complete - salesOrders additionalProperties: false Error: type: object properties: error: type: string description: What went wrong. required: - error additionalProperties: false OsnSalesOrder: type: object properties: salesOrderNumber: type: string description: DEKHQ sales order number. complete: type: boolean description: All shipments for this sales order are complete. locations: type: array items: $ref: '#/components/schemas/OsnShipmentLocation' required: - salesOrderNumber - complete - locations additionalProperties: false OsnShipmentLocation: type: object properties: id: type: integer description: Location number within the sales order. complete: type: boolean description: All shipments for this location are complete. shipFromAddress: $ref: '#/components/schemas/OsnAddress' shipToAddress: $ref: '#/components/schemas/OsnAddress' packages: type: array items: $ref: '#/components/schemas/OsnPackage' required: - id - complete - shipFromAddress - shipToAddress - packages additionalProperties: false OsnAddress: type: object properties: address1: type: string description: Address line 1. address2: type: string description: Address line 2. city: type: string description: City. region: type: string description: State or region code. postalCode: type: string description: Postal code. country: type: string description: Country code. required: - address1 - city - region - postalCode additionalProperties: false OsnPackage: type: object properties: id: type: integer description: Package number within the location. trackingNumber: type: string description: Carrier tracking number. shipmentDate: type: string description: When the package shipped. format: date-time carrier: type: string description: Carrier. shipmentMethod: type: string description: Service level, e.g. Ground. weight: type: number description: Package weight. weightUOM: type: string description: Weight unit. required: - trackingNumber additionalProperties: false securitySchemes: basicAuth: type: http scheme: basic description: Your DEKHQ partner `id` and `password`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.