Update Shipping Status Of Multiple Packages

Updated 2 weeks ago ​by nussi

Overview

Endpoint is used for updating shipping status of many order packages in bulk. In order to do that you must:

  • Be authenticated user

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/MultiplePackages

For your server endpoint will be:

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

Request

  • Method Type: HttpPut
  • Authorization: Use Bearer Token + token received from token authentication
  • Header info: Content-Type: application/json
  • Body data:

    Parameter

    Data Type

    Description

    Is Required

    OrderID

    integer

    ID of existing order

    Yes

    ShippingCarrier

    string

    ShippingService

    string

    ShippingCarrierType

    string

    StationID

    integer

    LocationID

    integer

    SendConfirmation

    bool

    No

    DeclaredValue

    integer

    Declared Value

    ShipFromProperWarehouse

    int

    ID of the warehouse

    CustomShipFromWarehouseID

    int

    ID of the warehouse

    Items

    Packages

Response

  • If server error appears, then response will be with status code 500 => Internal Server Error
  • If updating order packages is fully or partially successful then response will be in the following format:
{
OrderID: 1
NewPackages: [{oldPackageID, newPackageID}],
UpdatedServerSide: true,
Error: ["error info"]
}


How did we do?