POST
/
shipping
/
shipments
curl --request POST \
  --url https://services.commercengine.dev/api/v1/x2yh61zw4k/admin/shipping/shipments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "order_number": "<string>",
  "warehouse_id": "<string>",
  "shipment_items": [
    {
      "product_id": "<string>",
      "sku": "<string>",
      "quantity": 123
    }
  ],
  "courier_option": "Shiprocket",
  "package_option": "Automatic",
  "boxes": [
    {
      "box_name": "<string>",
      "box_length": 123,
      "box_width": 123,
      "box_height": 123,
      "box_weight": 123,
      "packed_items_count": 123
    }
  ],
  "tracking_link": "<string>",
  "expected_delivery_date": "2023-12-25",
  "shipping_charges": 123
}'
{
  "message": "<string>",
  "success": true
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Create shipment model

order_number
string
warehouse_id
string
shipment_items
object[]
courier_option
enum<string>
Available options:
Shiprocket,
Custom
package_option
enum<string>
Available options:
Automatic,
Custom
boxes
object[] | null

use this field for courier_option = custom

use this field for courier_option = custom

expected_delivery_date
string | null

use this field for courier_option = custom

shipping_charges
number | null

use this field for courier_option = custom

Response

200 - application/json
OK
message
string
success
boolean