Update Tracking Information

Overview

This endpoint is used for marking an 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.

In order to use this endpoint, you must:

  • Be authenticated

For information on how you can authenticate, see: Authentication

As soon as you do authentication and receive a valid token, it needs to be passed on the call when updating the order.

  • Have valid ID of an existing order

Endpoint

Example for such endpoint for TT server is

https://tt.api.sellercloud.com/rest/api/Orders/ShippingStatus/

For your server endpoint will be:

https://{your_server_id}.sellercloud.com/rest/api/Orders/ShippingStatus/

Request

  • Method Type: HttpPut
  • Authorization: Use Bearer Token + token received from token authentication
  • Header info: Content-Type: application/json
  • Body data:
    ParameterData TypeDescriptionIs Required
    OrderIDintegerID of existing sales orderYes
    ShippingCarrierstringFedEx, DHL, UPS etc.Yes
    ShippingServicestringShipping service of the carrier.Yes
    ShipFromWarehouseIDintID of warehouse for shipping.No
    DeclaredValuedecimalDeclared value. Optional field that will be set on the first package.No
    ShipDatedatetimeShipping date. It cannot be a future date and cannot be earlier than the date of order creation.Yes
    TrackingNumberstringTracking number. Optional field that will be set on the first package.No
    ShippingCostdecimalShipping cost. Optional field that will be set as FinalShippingFee of the first package.No
    WidthdoubleWidth of the first package.

    Optional field.

    No
    HeightdoubleHeight of the first package.

    Optional field.

    No
    LengthdoubleLength of the first package.

    Optional field.

    No
    WeightdoubleWeight of the first package.

    Optional field.

    No

Request Example

Response

  • If server error appears, then response will be status code 500 => Internal Server Error
  • If updating shipping status is successful, response will be status code 200 => Ok

Was this article helpful?

Next
Update Inventory Info for Single Product