Update Inbound Order Tracking

POST

/fbt/202602/inbound_orders/tracking_update

Updates carton-level tracking information for an inbound order after shipment and before the order is marked as Delivered or Received. When updating tracking, send the complete desired parcel_tracking_info list; entries omitted from a non-empty submission are not retained, so this is not a partial patch. The first tracking value for a carton does not count as an edit, and resubmitting the same normalized value does not consume another edit. Changing an existing carton’s tracking number consumes one of the five allowed edits for that carton; a sixth change is rejected before the local update. The submitted carton updates are applied atomically to the stored tracking list: either the complete local replacement is saved or none of it is. Warehouse synchronization and logistics tracking registration occur outside this atomic update; warehouse synchronization failures are not returned, and tracking registration runs asynchronously.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

Request Body^required

Media typeapplication/json

object

order_id

required

The numeric identifier of the inbound order to update tracking information for.
Note: Provide the numeric sequence only; do not include the “IBR” prefix (e.g., use 123456 instead of IBR123456).

string

parcel_tracking_info

Carton-level parcel tracking information for the inbound order, including carton number, logistics provider name, and tracking number.

Array<object>

object

provider_name

required

The provider_name field must contain exactly one of the following strings.

• FEDEX (Federal Express)
• UPS (United Parcel Service)
• DHL (DHL Express)
• USPS (United States Postal Service)
• OTHER (All other logistics providers)

Note: Input must match the uppercase string exactly (e.g., "provider_name": "FEDEX").

string

tracking_number

required

The tracking number to associate with this carton. It must not be empty or contain only whitespace, and it may contain only ASCII letters, digits, spaces, and hyphens. After spaces and hyphens are removed, 8 to 40 letters or digits must remain.

string

carton_number

required

The carton number of an existing carton in this inbound order. After leading and trailing whitespace is removed, this value is matched to the carton whose tracking information is created or replaced.

string

Example

{
  "order_id": "5766071177167344427",
  "parcel_tracking_info": [
    {
      "provider_name": "FEDEX",
      "tracking_number": "889042812410",
      "carton_number": "C0001"
    }
  ]
}

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

Example

{
  "code": 0,
  "data": {},
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}