Update Shipping Status Of Single Package

Overview

Endpoint is used for updating shipping status of a single order package. 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/SinglePackage

For your server 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 data:

    Parameter

    Data Type

    Description

    Is Required

    OrderID

    integer

    ID of existing order

    Yes

    ShipDate

    date time

    Sipping Date

    Yes

    TrackingNumber

    string

    Tracking Number

    ShippingCost

    decimal

    Cost of shipping

    CurrencyCode

    string

    Currency Code

    PackageID

    int

    ID of the package that will be updated. If not provided in the request, then first package order will be updated.

    No

    CarrierName

    string

    Name of the carrier

    ShippingMethod

    string

    Name of the shipping method

    WarehouseID

    int

    ID of the warehouse

    Yes

Response

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

How did we do?