curl --request POST \
--url https://api.wizcommerce.com/v1/shipments \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"reference_id": "<string>",
"order_id": "<string>",
"created_at": "<string>",
"shipment_status": "shipped",
"tracking_info": {
"tracking_number": "<string>",
"tracking_url": "<string>",
"delivery_partner": "<string>"
},
"note": "Handle with care",
"name": "Shipment Name",
"shipment_items": [
{
"product_id": "<string>",
"quantity": 2
}
]
}'
{
"data": {
"id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
"reference_id": "123",
"order_id": "123",
"created_at": "2021-01-01T00:00:00Z",
"status": "shipped",
"tracking_info": {
"tracking_number": "123",
"tracking_url": "https://www.google.com",
"delivery_partner": "Fedex"
},
"shipment_items": [
{
"id": "123",
"sku_id": "123",
"quantity": 10
}
],
"updated_at": "2021-01-01T00:00:00Z",
"note": "Handle with care"
}
}
Create Shipment
curl --request POST \
--url https://api.wizcommerce.com/v1/shipments \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"reference_id": "<string>",
"order_id": "<string>",
"created_at": "<string>",
"shipment_status": "shipped",
"tracking_info": {
"tracking_number": "<string>",
"tracking_url": "<string>",
"delivery_partner": "<string>"
},
"note": "Handle with care",
"name": "Shipment Name",
"shipment_items": [
{
"product_id": "<string>",
"quantity": 2
}
]
}'
{
"data": {
"id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
"reference_id": "123",
"order_id": "123",
"created_at": "2021-01-01T00:00:00Z",
"status": "shipped",
"tracking_info": {
"tracking_number": "123",
"tracking_url": "https://www.google.com",
"delivery_partner": "Fedex"
},
"shipment_items": [
{
"id": "123",
"sku_id": "123",
"quantity": 10
}
],
"updated_at": "2021-01-01T00:00:00Z",
"note": "Handle with care"
}
}
API Key for authentication
Shipment
The body is of type object
.
Created
The response is of type object
.
Was this page helpful?