Update shipping status

Updated 2 weeks ago ​by nussi

Overview

In order to update shipping status of an order, you must:

  • Be authenticated user

Information how you can authenticate can take from: 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

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

    Carrier

    ShippingService

    string

    Service

    Yes

    ShippingCarrierType

    string

    FinalShippingCarrierType - described in the next section

    StationID

    integer

    ID of the station for that order

    LocationID

    integer

    ID of the location for that order

    SendConfirmation

    bool

    If to send shipping confirmation email

    Yes

    DeclaredValue

    decimal

    Declared value amount for an order

    Yes

    ShipFromProperWarehouse

    boolean

    Is shipped from proper warehouse

    CustomShipFromWarehouseID

    integer

    ID of an warehouse

    Items

    List of order items

    Info about order items

    Yes

    Packages

    List of packages

    Information about packages: ID of package, costs, weights etc.

    Yes

Response

  • If server error appears, then response will be with status code 500 => Internal Server Error
  • If we succeed updating the order order, but some issues appear or not, response will be with following format:
{
  OrderID: 1
  NewPackages: [{oldPackageID, newPackageID}],
  UpdatedServerSide: true,
  Error: ["error info"]
}

How did we do?