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

# getOrderStatusTypes

> Lists the order status codes DEKHQ reports, with their names. Call it once to map the statusID values that getOrderStatusDetails returns.

Lists the order status codes DEKHQ reports, with their names. Call it once to map the `statusID` values that getOrderStatusDetails returns.

## Endpoint

`POST https://partners.dekhq.com/api/promostandards/order-status`

* **WSDL:** [`https://partners.dekhq.com/api/promostandards/order-status?wsdl`](https://partners.dekhq.com/api/promostandards/order-status?wsdl). The schemas it imports are served beside it.
* **Service:** PromoStandards Order Status 1.0.0, SOAP 1.1 (document/literal)
* **Namespace:** `http://www.promostandards.org/WSDL/OrderStatusService/1.0.0/`
* **Request headers:** `Content-Type: text/xml; charset=utf-8`. `SOAPAction: "getOrderStatusTypes"` is accepted but not required; DEKHQ picks the operation from the body element.
* **Responses:** `text/xml; charset=utf-8`, HTTP 200 on success.

## Authentication

Send the `id` and `password` DEKHQ issued you in the request body. Your credential must be enabled for the `order_status` scope. Each credential is limited to 300 requests per minute; above that you get a rate-limit fault with a `Retry-After` header.

## How DEKHQ handles it

* Returns the same fixed list for every partner.

## Request fields

Element `GetOrderStatusTypesRequest`.

| Field | Type | Required | Description |
| - | - | - | - |
| `wsVersion` | string (max 64 chars) | Yes | The Standard Version of the Web Service being referenced **DEKHQ:** Accepted; DEKHQ does not check it. Send `1.0.0`. |
| `id` | string (max 64 chars) | Yes | The customerID or any other agreed upon ID. |
| `password` | string (max 64 chars) | No | The password associated with the customerID. |

## Response fields

Element `GetOrderStatusTypesResponse`.

| Field | Type | Required | Description |
| - | - | - | - |
| `StatusArray` | object | Yes | An Array of order statuses |
| ↳ `Status` | object\[] | Yes | 10 - Order Received (Order has been received) 11 - Order Entry Hold (Vendor has a problem with the data in the purchase order, and it is preventing the order from being entered) 20 - Order Confirmed (Order has been received, entered, and accepted) 30 - Pre‐Production (Vendor has begun to process the order, but it is not in production) 40 - General Hold (Something is preventing the order from being entered) 41 - Credit Hold (Vendor is awaiting payment from customer) 42 - Proof Hold (Vendor is awaiting response to proof) 43 - Art Hold (Vendor is awaiting suitable artwork from customer) 44 - Back Order (Hold Order has been backordered; Nothing has shipped yet.) 60 - In Production (Production of the order has started) 70 - In Storage (Order is complete, but vendor is waiting to ship goods) 75 - Partial Shipment (Order has shipped in Part; remaining items in production) 80 - Complete (Order has shipped in full—No further updates will be given) 99 - Canceled (Order has been canceled—No further updates will be given) |
| ↳ ↳ `id` | int | Yes | The numerical value of the order status |
| ↳ ↳ `name` | string (max 256 chars) | Yes | The string status name from possible values |
| `errorMessage` | string (max 256 chars) | No | Response for any error requiring notification to requestor **DEKHQ:** Not used. DEKHQ reports errors as SOAP faults (see Errors). |

## Errors

Errors come back as SOAP 1.1 faults. The schema's `errorMessage` element is not used.

| faultcode | faultstring | HTTP status | When |
| - | - | - | - |
| `soap:Client` | Malformed SOAP request | 500 | The body is not a SOAP envelope with an operation element. |
| `soap:Client` | Invalid id or password | 500 | The `id`/`password` pair is unknown or inactive. |
| `soap:Client` | Credential not permitted for scope: order\_status | 500 | Your credential is not enabled for this service. |
| `soap:Client` | Unsupported operation: \<operation> | 500 | The operation is not one this endpoint serves. |
| `soap:Server` | Rate limit exceeded — retry later | 429 | More than the allowed requests per minute. Wait for the `Retry-After` header (seconds). |
| `soap:Server` | Internal error | 500 | An unexpected error on our side. It is logged; retry later. |

## Example

Sample data is fictional.

<CodeGroup>
  ```xml Request theme={null}
  <?xml version="1.0" encoding="UTF-8"?>
  <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
      <ns:GetOrderStatusTypesRequest xmlns:ns="http://www.promostandards.org/WSDL/OrderStatusService/1.0.0/">
        <ns:wsVersion>1.0.0</ns:wsVersion>
        <ns:id>example-partner</ns:id>
        <ns:password>example-password</ns:password>
      </ns:GetOrderStatusTypesRequest>
    </soap:Body>
  </soap:Envelope>
  ```

  ```xml Response theme={null}
  <?xml version="1.0" encoding="UTF-8"?>
  <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
      <ns:GetOrderStatusTypesResponse xmlns:ns="http://www.promostandards.org/WSDL/OrderStatusService/1.0.0/">
        <ns:StatusArray>
          <ns:Status>
            <ns:id>10</ns:id>
            <ns:name>Order Received</ns:name>
          </ns:Status>
          <ns:Status>
            <ns:id>20</ns:id>
            <ns:name>Order Confirmed</ns:name>
          </ns:Status>
          <ns:Status>
            <ns:id>40</ns:id>
            <ns:name>General Hold</ns:name>
          </ns:Status>
          <ns:Status>
            <ns:id>60</ns:id>
            <ns:name>In Production</ns:name>
          </ns:Status>
          <ns:Status>
            <ns:id>80</ns:id>
            <ns:name>Complete</ns:name>
          </ns:Status>
          <ns:Status>
            <ns:id>99</ns:id>
            <ns:name>Canceled</ns:name>
          </ns:Status>
        </ns:StatusArray>
      </ns:GetOrderStatusTypesResponse>
    </soap:Body>
  </soap:Envelope>
  ```

  ```xml Fault theme={null}
  <?xml version="1.0" encoding="UTF-8"?>
  <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
      <soap:Fault>
        <faultcode>soap:Client</faultcode>
        <faultstring>Invalid id or password</faultstring>
      </soap:Fault>
    </soap:Body>
  </soap:Envelope>
  ```
</CodeGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.