GET
/
v1
/
order
/
:id
/
retrieve
curl --location --request GET 'https://api.stateset.com/v1/order/retrieve' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "id": "ord_1NXWPnCo6bFb1KQto6C8OWvE",
}'
{
  "order": {
    "id": "ord_1NXWPnCo6bFb1KQto6C8OWvE",
    "name": "Example Order",
    "order_number": "ORD-12345",
    "created_date": "2023-08-23T10:00:00Z",
    "updated_date": "2023-08-23T11:00:00Z",
    "order_status": "Processing",
    "imported_status": "Completed",
    "delivery_date": "2023-08-30T14:00:00Z",
    "ordered_by": "John Doe",
    "delivery_address": "123 Main St, Anytown, AN 12345",
    "notes": "Please handle with care",
    "imported_date": "2023-08-23T09:00:00Z",
    "customer_number": "CUST-6789",
    "customer_name": "John Doe",
    "import": true,
    "customer_email": "john.doe@example.com",
    "source": "Online Store",
    "buyer_email": "john.doe@example.com",
    "buyer_message": "Looking forward to receiving the order!",
    "cancel_order_sla_time": null,
    "cancel_reason": null,
    "cancellation_initiator": null,
    "fulfillment_type": "Standard",
    "delivery_type": "Home Delivery",
    "is_cod": false,
    "is_replacement_order": false,
    "seller_note": "Thank you for your order",
    "status": "Processing",
    "tracking_number": "TRACK-98765",
    "warehouse_id": "wh_2MXYQoDp7cGc2LRup7D9PXvF",
    "order_line_items": [
      {
        "id": "oli_3OYZRpEq8dHd3MSvq8E0QYwG",
        "wholesale_order_id": "ord_1NXWPnCo6bFb1KQto6C8OWvE",
        "product_name": "Example Product",
        "quantity": "2",
        "created_date": "2023-08-23T10:05:00Z",
        "updated_date": "2023-08-23T10:05:00Z",
        "unit": "piece",
        "product_id": "prod_4PZaSqFr9eIe4NTwr9F1RZxH",
        "brand": "Example Brand",
        "stock_code": "EX-1234",
        "size": "Medium",
        "status": "In Stock",
        "sale_price": 2999,
        "seller_discount": 500,
        "seller_sku": "SKU-5678",
        "sku_id": "sku_6QAbTrGs0fJf5OUxs0G2SZyI",
        "sku_image": "https://example.com/images/product.jpg",
        "sku_name": "Example Product - Medium",
        "sku_type": "Standard",
        "original_price": 3499
      }
    ]
  }
}

Body

id
string
This is the id of the order.

Response

id
string
This is the id of the order.
name
string
This is the name of the order.
order_number
string
This is the order number.
created_date
string
This is the date the order was created.
updated_date
string
This is the date the order was last updated.
order_status
string
This is the status of the order.
imported_status
string
This is the imported status of the order.
delivery_date
string
This is the delivery date of the order.
ordered_by
string
This is the person who ordered.
delivery_address
string
This is the delivery address for the order.
notes
string
These are additional notes for the order.
imported_date
string
This is the date the order was imported.
customer_number
string
This is the customer number associated with the order.
customer_name
string
This is the name of the customer.
import
boolean
This indicates if the order was imported.
customer_email
string
This is the email of the customer.
source
string
This is the source of the order.
buyer_email
string
This is the email of the buyer.
buyer_message
string
This is a message from the buyer.
cancel_order_sla_time
string
This is the SLA time for cancelling the order.
cancel_reason
string
This is the reason for cancellation, if applicable.
cancellation_initiator
string
This is who initiated the cancellation, if applicable.
fulfillment_type
string
This is the type of fulfillment for the order.
delivery_type
string
This is the type of delivery for the order.
is_cod
boolean
This indicates if the order is cash on delivery.
is_replacement_order
boolean
This indicates if this is a replacement order.
seller_note
string
This is a note from the seller.
status
string
This is the current status of the order.
tracking_number
string
This is the tracking number for the order.
warehouse_id
string
This is the id of the warehouse handling the order.
order_line_items
array
These are the line items associated with the order.
curl --location --request GET 'https://api.stateset.com/v1/order/retrieve' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "id": "ord_1NXWPnCo6bFb1KQto6C8OWvE",
}'
{
  "order": {
    "id": "ord_1NXWPnCo6bFb1KQto6C8OWvE",
    "name": "Example Order",
    "order_number": "ORD-12345",
    "created_date": "2023-08-23T10:00:00Z",
    "updated_date": "2023-08-23T11:00:00Z",
    "order_status": "Processing",
    "imported_status": "Completed",
    "delivery_date": "2023-08-30T14:00:00Z",
    "ordered_by": "John Doe",
    "delivery_address": "123 Main St, Anytown, AN 12345",
    "notes": "Please handle with care",
    "imported_date": "2023-08-23T09:00:00Z",
    "customer_number": "CUST-6789",
    "customer_name": "John Doe",
    "import": true,
    "customer_email": "john.doe@example.com",
    "source": "Online Store",
    "buyer_email": "john.doe@example.com",
    "buyer_message": "Looking forward to receiving the order!",
    "cancel_order_sla_time": null,
    "cancel_reason": null,
    "cancellation_initiator": null,
    "fulfillment_type": "Standard",
    "delivery_type": "Home Delivery",
    "is_cod": false,
    "is_replacement_order": false,
    "seller_note": "Thank you for your order",
    "status": "Processing",
    "tracking_number": "TRACK-98765",
    "warehouse_id": "wh_2MXYQoDp7cGc2LRup7D9PXvF",
    "order_line_items": [
      {
        "id": "oli_3OYZRpEq8dHd3MSvq8E0QYwG",
        "wholesale_order_id": "ord_1NXWPnCo6bFb1KQto6C8OWvE",
        "product_name": "Example Product",
        "quantity": "2",
        "created_date": "2023-08-23T10:05:00Z",
        "updated_date": "2023-08-23T10:05:00Z",
        "unit": "piece",
        "product_id": "prod_4PZaSqFr9eIe4NTwr9F1RZxH",
        "brand": "Example Brand",
        "stock_code": "EX-1234",
        "size": "Medium",
        "status": "In Stock",
        "sale_price": 2999,
        "seller_discount": 500,
        "seller_sku": "SKU-5678",
        "sku_id": "sku_6QAbTrGs0fJf5OUxs0G2SZyI",
        "sku_image": "https://example.com/images/product.jpg",
        "sku_name": "Example Product - Medium",
        "sku_type": "Standard",
        "original_price": 3499
      }
    ]
  }
}