---
title: "View Order Status"
method: GET
path: "/v1/merchant/orders/status/{CUST_REF}"
tags: ["Merchant API"]
---

# View Order Status

`GET /v1/merchant/orders/status/{CUST_REF}`

## Request

- Base URL: `http://{{base_url}}`
- URL: `http://{{base_url}}/v1/merchant/orders/status/{CUST_REF}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/extensiv/apis/integration-manager-api-formerly-cartrover/docs/v1/merchant/orders/status/:CUST_REF/get.ts> (a function with typed inputs; its response is checked against the schema)

This will return the order status and tracking information for the specified CUST_REF.

CUST_REF is guaranteed to be unique for all orders for a merchant.

### Response Fields

|    Field                    |    Data Type    |    Length    |    Description                                                             |
|-----------------------------|-----------------|--------------|----------------------------------------------------------------------------|
|    cust_ref                 |    String       |    16        |                                                                            |
|    cust_po_no               |    String       |    45        |                                                                            |
|    delivered_to_wms_date    |    Timestamp    |              |                                                                            |
|    order_status             |    Enum         |              |    One of: new, at_wms, shipped, confirmed, error, canceled    |
|    shipments                |    **Array**        |              |    Array of 0 or more shipments                              |

#### Shipments Array Fields

|    Field                      |    Data Type    |    Length              |    Description                                   |
|-------------------------------|-----------------|------------------------|--------------------------------------------------|
|    carrier                    |    String       |    45                  |    Carrier reported by WMS                       |
|    method                     |    String       |    45                  |    Ship Method reported by WMS                   |
|    tracking_no                |    String       |    45                  |    Primary tracking #                            |
|    tracking_no_secondary      |    String       |    45                  |    Optional secondary tracking #                 |
|    sscc_barcode               |    String       |    45                  |    Carton Barcode for EDI Orders                 |
|    bill_of_lading             |    String       |    45                  |                                                  |
|    total_cost                 |    Float        |    2 decimal places    |    Shipping cost with all fees                   |
|    package_weight_lbs         |    Float        |    2 decimal places    |    Actual shipment weight                        |
|    dim_weight_lbs             |    Float        |    2 decimal places    |    Optional dimensional weight                   |
|    zone                       |    String       |    4                   |    Ship-to zone                                  |
|    delivery_surcharge_type    |    String       |    45                  |    Defined by WMS                                |
|    whs_location               |    String       |    45                  |    Identifies which warehouse shipped package    |
|    box_length_in              |    Float        |    2 decimal places    |    Length in Inches                              |
|    box_width_in               |    Float        |    2 decimal places    |    Width in Inches                               |
|    box_height_in              |    Float        |    2 decimal places    |    Height in Inches                              |
|    date                       |    Timestamp    |                        |    Shipping date                                 |
|    tracking_url               |    String       |                        |    URL to track shipment                         |
|    custom_1                   |    String       |    45                  |    Defined by WMS                                |
|    items                      |    **Array**        |                        |    List of items in package if known             |

#### Items Array Fields

|    Field                      |    Data Type    |    Length              |    Description                                   |
|-------------------------------|-----------------|------------------------|--------------------------------------------------|
|    carrier                    |    String       |    45                  |   Product SKU - Must match SKU on original order      |
|    quantity                    |    Int       |                      |     Quantity of item in package     |
|    carton_code                    |    String       |    45                  |    Carton code/barcode (eg: SSCC-18)      |
|    carton_num                    |    String       |    45                  |      Carton number (eg: 1, 2, 3, etc)        |
|    box_length_in                    |    Float       |    2 decimal places          |    Length in Inches    |
|    box_width_in                    |    Float       |    2 decimal places          |     Width in Inches       |
|    box_height_in                    |    Float       |    2 decimal places          |     Height in Inches       |
|    package_weight_lbs                    |    Float       |    2 decimal places          |     	Carton weight in lbs        |

## Path parameters

- `CUST_REF` string, required

## Response `200`

OK

- object

---

[API](https://skmtc.dev/extensiv/apis/integration-manager-api-formerly-cartrover.md) - [All operations](https://skmtc.dev/extensiv/apis/integration-manager-api-formerly-cartrover/llms.txt) - [OpenAPI document](https://skmtc.dev/extensiv/apis/integration-manager-api-formerly-cartrover/revisions/125e6deac675?raw)