Skip to product menu
Skip to main content

Mark as Shipped

OAuthScope

ZohoCommerce.shipmentorders.CREATE

 

HTTP Request

POST https://commerce.zoho.com/store/api/v1/salesorders/{order_id}/shipmentorders/shipped 

 

Body JSON Parameters

ParameterDescription
shipment_date*string: Shipment date of the sales order.
tracking_number*string: Tracking number of shipment.
carrier*string: Carrier used for shipment.
servicestring: Type of service selected for shipment.
tracking_url string: The tracking URL of the shipment.

 

Request Example

Copiedcurl -i -L -X POST
-H "Content-Type:application/json"
-H "Authorization:Zoho-oauthtoken ***"
-H "X-com-zoho-store-organizationid:58927961"
-d
'{ "shipment_date": "2019-09-30",
"tracking_number": "1323",
"carrier": "India Post",
"service": "Speed post",
"tracking_url":"https://www.golcom.com"
}'
'https://commerce.zoho.com/store/api/v1/salesorders/51128000000118140/shipmentorders/shipped'

Success Response

Copied{
"code": 0,
"message": "Shipment order created for the SO.",
"salesorder":{
"invoices":[
{
"invoice_id": "51128000000118154",
"invoice_number": "INV-000009",
"status": "paid",
"date": "2019-09-30",
"due_date": "2019-09-30",
"total": 110,
"balance": 0
}
],
"shipment_date": "2019-09-30",
"tracking_number": "1323",
"carrier": "India Post",
"service": "Speed post",
"tracking_url": "https://www.golcom.com",
"delivery_date": ""
}
}

Show full

Show less

Failure Response

Copied{
"code": 1002,
"message": "Package does not exist."
}
Use this API to change your order status to shipped.