> ## 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 status

> Current status of your orders. Only orders for the clients your credential is linked to, and only orders with a PO number. At most 5,000 orders.



## OpenAPI

````yaml /api/promostandards/openapi.json get /api/partners/v1/orders/status
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/status:
    get:
      summary: Order status
      description: >-
        Current status of your orders. Only orders for the clients your
        credential is linked to, and only orders with a PO number. At most 5,000
        orders.
      operationId: getOrderStatus
      parameters:
        - name: queryType
          in: query
          required: true
          description: >-
            1 = PO number, 2 = sales order number, 3 = changed since
            `statusTimeStamp`, 4 = all open orders. Other values return an empty
            list.
          schema:
            type: integer
            enum:
              - 1
              - 2
              - 3
              - 4
        - name: referenceNumber
          in: query
          required: false
          description: PO number (queryType 1) or sales order number (queryType 2).
          schema:
            type: string
        - name: statusTimeStamp
          in: query
          required: false
          description: ISO 8601 time; queryType 3 returns orders changed since then.
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Matching orders.
          content:
            application/json:
              schema:
                type: object
                properties:
                  orders:
                    type: array
                    items:
                      $ref: '#/components/schemas/OrderStatusEntry'
                required:
                  - orders
                additionalProperties: false
              example:
                orders:
                  - purchaseOrderNumber: PO-10042
                    details:
                      - factoryOrderNumber: SO-58817
                        statusID: 60
                        statusName: In Production
                        expectedShipDate: '2026-02-12T00:00:00Z'
                        expectedDeliveryDate: '2026-02-16T00:00:00Z'
                        responseRequired: false
                        validTimestamp: '2026-02-05T15:30:00Z'
        '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:
    OrderStatusEntry:
      type: object
      properties:
        purchaseOrderNumber:
          type: string
          description: Your purchase order number.
        details:
          type: array
          items:
            $ref: '#/components/schemas/OrderStatusDetail'
      required:
        - purchaseOrderNumber
        - details
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: string
          description: What went wrong.
      required:
        - error
      additionalProperties: false
    OrderStatusDetail:
      type: object
      properties:
        factoryOrderNumber:
          type: string
          description: DEKHQ sales order number.
        statusID:
          type: integer
          description: PromoStandards status ID (see getOrderStatusTypes).
        statusName:
          type: string
          description: Name of the status.
        expectedShipDate:
          type: string
          description: Expected ship date.
          format: date-time
        expectedDeliveryDate:
          type: string
          description: Expected delivery date.
          format: date-time
        responseRequired:
          type: boolean
          description: Whether DEKHQ needs a response from you.
        validTimestamp:
          type: string
          description: When this status took effect.
          format: date-time
      required:
        - factoryOrderNumber
        - statusID
        - statusName
        - responseRequired
        - validTimestamp
      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.