Order List

API Reference

Environment	Method	Endpoint
Sandbox	GET	https://api-develop.unimall.ai/supplier/orders
Production	GET	https://api-prod.unimall.ai/supplier/orders

Description

This method allows you to get the list of orders.

Query Parameters

Paramater	Type	Required	Description
UnimallOrderNumbers	Array String	No	You may add max 10 UnimallOrderNumbers for each request
Statuses	Array String	No	Order status; - New: Item is created - Defected: Item is defected - Packed: Item is packed - Canceled: Item is canceled - Shipped: Item is shipped - Returned: Item is returned - Delivered: Item is delivered - Delivery Failed: Delivery failed for the item
OrderDateFrom	String (Date Time)	No	ie; 2024-07-23T17:42:52Z
OrderDateTo	String (Date Time)	No	ie; 2024-07-23T17:42:52Z
Page	Integer	No	Page number.
Size	Integer	No	Number of values per page. Default 20. Max 100

Sample Curl Request

curl -X 'GET' \
    'https://api-develop.unimall.ai/supplier/orders?OrderDateFrom=2024-07-01T17%3A42%3A52Z&OrderDateTo=2024-07-30T17%3A42%3A52Z&Page=0&Size=1' \
    -H 'accept: text/plain' \
    -H 'X-API-Key: *****'

Sample Response

HTTP 200

{
  "totalCount": 25,
  "results": [
    {
      "orderDate": "2024-07-23T17:42:52Z",
      "updatedAt": "2024-09-11T05:10:37.838Z",
      "status": "New",
      "unimallOrderNumber": "UNI07230009",
      "timeForPackaging": "2024-07-25T17:42:52Z",
      "orderItems": [
        {
          "parentSku": "US000001",
          "sku": "US000001-0001",
          "name": "SEAMLESS RIBBED FADED CROP TOP",
          "quantity": 1,
          "salePrice": 239,
          "warehouses": [
            {
              "warehouseName": "Default",
              "quantity": 2
            }
          ]
        }
      ]
    }
  ]
}