GET
/
shipping
/
shipments
/
{order-number}
curl --request GET \
  --url https://services.commercengine.dev/api/v1/x2yh61zw4k/admin/shipping/shipments/{order-number} \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "success": true,
  "content": {
    "shipment": {
      "order_number": "<string>",
      "order_date": "2023-11-07T05:31:56Z",
      "order_status": "<string>",
      "payment_status": "pending",
      "customer_name": "<string>",
      "shipments": [
        {
          "shipment_number": "<string>",
          "warehouse_id": "<string>",
          "warehouse_name": "<string>",
          "status": "<string>",
          "total_weight": 123,
          "total_boxes": 123,
          "shipment_items_count": 123,
          "shipping_amount": 123,
          "shipping_tax_amount": 123,
          "shipping_amount_including_tax": 123,
          "courier_company_name": "<string>",
          "awb_no": "<string>",
          "shipping_label_url": "<string>",
          "eta_delivery": "<string>",
          "shipped_date": "<string>",
          "delivered_date": "<string>",
          "slo": {
            "expected_date": "2023-12-25",
            "actual_date": "2023-12-25",
            "difference": "<string>"
          },
          "cancellation_reason": "<string>",
          "created_at": "<string>",
          "modified_at": "<string>",
          "shipment_items": [
            {
              "product_id": "<string>",
              "product_name": "<string>",
              "product_image_url": "<string>",
              "sku": "<string>",
              "quantity": 123,
              "free_quantity": 123,
              "is_free_item": true
            }
          ],
          "packaging": {
            "package_option": "Automatic",
            "boxes_count": 123,
            "boxes": [
              {
                "box_name": "<string>",
                "box_length": 123,
                "box_width": 123,
                "box_height": 123,
                "box_weight": 123,
                "packed_items_count": 123
              }
            ]
          }
        }
      ],
      "allowed_actions": [
        "Refund shortfall"
      ]
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

order-number
string
required

Order number

Response

200 - application/json
OK
message
string
success
boolean
content
object