Order Pack

API Reference

Environment	Method	Endpoint
Sandbox	POST	https://api-develop.unimall.ai/supplier/orders/{orderNumber}/package
Production	POST	https://api-prod.unimall.ai/supplier/orders/{orderNumber}/package

Description

This method allows you to pack the order items.

You can pack the orders, if the order status is “New”.

You need to send the unimallOrderNumber in the request url to pack the order.

If you can supply the order item, send the isSupplied field as true which is available in the request body.

If you don’t have stock for the order item, send the isSupplied field as false which is available in the request body.

Watch out!

If an order contains multiple items, it’s important to provide the supply information for each item within the same request. That’s why the ‘items’ field is structured as an array, allowing you to include details for all order items together.

Request Parameters

Field Name	Type	Is Required	Validation Rules	Description	Sample Input
items	Array	Yes	-	The items to be packed.	[{ “sku”: “UM1000000001”, “isSupplied”: true }, { “sku”: “UM1000000002”, “isSupplied”: false }]
items[].sku	String	Yes	-	The SKU of the item to be packed.	UM1000000001
items[].isSupplied	Boolean	Yes	-	Whether the item is supplied.	true

Sample Curl Request

curl -X 'POST' \
  'https://api-develop.unimall.ai/supplier/orders/UNI08140010/package' \
  -H 'accept: text/plain' \
  -H 'X-API-Key: *****' \
  -H 'Content-Type: application/json' \
  -d '{
  "items": [
    {
      "sku": "US000001-0001",
      "isSupplied": true
    }
  ]
}'

Sample Response

HTTP 200

{
  "orderDate": "2024-08-14T10:27:35Z",
  "updatedAt": "2024-09-11T05:20:14.528Z",
  "status": "Shipped",
  "unimallOrderNumber": "UNI08140010",
  "timeForPackaging": "2024-08-16T10:27:35Z",
  "orderItems": [
    {
      "parentSku": "US000001",
      "sku": "US000001-0001",
      "name": "SEAMLESS RIBBED FADED CROP TOP",
      "quantity": 1,
      "salePrice": 444,
      "warehouses": [
        {
          "warehouseName": "Default",
          "quantity": 2
        }
      ]
    }
  ]
}