Overview
This endpoint is used for marking a single existing sales order as shipped by providing tracking and shipping information.
The endpoint supports setting one tracking number only. In the case of a multi-package order, this endpoint will mark the entire order as shipped and will update the tracking information on the first package.
If the order is to ship from a bin-enabled warehouse, you must ensure the necessary quantities are picked.
To consume this endpoint, you must be an Authenticated User. As soon as you receive a valid token, you need to pass it to the call. Additionally, you need a valid Sellercloud Order ID.
Endpoint
An example of this endpoint for server XX is:
https://xx.api.sellercloud.com/rest/api/Orders/ShippingStatus/SinglePackage/
For your server, the endpoint will be:
https://{your_server_id}.sellercloud.com/rest/api/Orders/ShippingStatus/SinglePackage/
Request
- Method Type: HttpPut
- Authorization: Use Bearer Token + token received from token authentication
- Header info: Content-Type: application/json
- Body parameters:
Parameter Data Type Description Is Required OrderID integer The Sellercloud Order ID of the existing sales order. Yes ShippingCarrier string Shipping Carrier Name (FedEx, DHL, UPS, etc.) Yes ShippingService string Shipping service of the carrier. Yes ShipFromWarehouseID integer The ID of the warehouse for shipping. No DeclaredValue decimal Declared value. No ShipDate datetime Shipping date. It cannot be a future date and cannot be earlier than the date of order creation. Yes TrackingNumber string Tracking number. No ShippingCost decimal Shipping cost. Optional field that will be set as FinalShippingFee of the first package. No Width integer Width of the first package. Provide in inches. No Height integer Height of the first package. Provide in inches. No Length integer Length of the first package. Provide in inches. No Weight integer Weight of the first package. Provide in ounces. No
Request Body
{
"OrderID": 0,
"ShipDate": "2026-08-10T09:30:00.197Z",
"TrackingNumber": "string",
"ShippingCost": 0,
"PackageID": 0,
"CarrierName": "string",
"ShippingMethod": "string",
"WarehouseID": 0,
"Length": 0,
"Width": 0,
"Height": 0,
"Weight": 0
}
Response
- If the user is authenticated, the response will be Status Code 200 => OK.
- If the user is not authenticated, then the response will be Status Code 401 => Not Valid Token.
- In case of an error, the response will be Status Code 500 => Internal Server Error.