post

/order/modify-tracking

Update tracking information about an order. Call this to change the tracking number or provider for an order that has already been marked shipped.

Returns

If the order is in the SHIPPED state, and all the parameters are correct, the API will update the tracking information of that order and return a HTTP status code of 200.

Request Body

Schema
object
id
string

Joom’s unique identifier for the order (order_id in the Order object)

required
tracking_number
string

The unique identifier that your carrier provided so that the user can track their package as it is being delivered. Tracking number should only contain alphanumeric characters with no space between them

tracking_provider
string

The carrier that will be shipping your package to its destination. See list of accepted providers

tracking_provider_id
string

ID of the carrier that will be shipping your package to its destination. See list of accepted providers

channel_id
string

Required for Joom Express orders. Need to pass channel_id value from the shipping_option from the order.

Responses

Schema
object
code
number

Contains the status code for the request, 0 means success and any other number implies a failure

1 validation + required
message
string

Sometimes will store a human readable status message to aid in debugging. It is generally used only for errors

required

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
host