Fields
data_updates
DataUpdatesInputSchema for data updates.
Example: { entities: [...], products: [...] }.
Example: { entities: [...], products: [...] }.
identifier
String!Required
The unique identifier for request which is the shipment_id. For example, '16736576489251696245'.
products
[ProductsInput]Specific bag to be updated. Example: [{ identifier: '21500347', line_number: 1, quantity: 1 }].
reasons
ReasonsDataInputUsed to capture cancellation, return, or failure reasons across both shipment (entity) and product (bag) levels. Example: { entities: [...], products: [...] }.
transition_comments
[TransitionCommentsInput]A list of comments or annotations provided during a status transition or data update on the shipment.
Each comment helps capture the intent, context, or the user action performed — such as assigning a delivery partner, updating address, or retrying delivery.
Useful for audit trails, communication, and debugging purposes.
refund_modes
[RefundMode]Modes for processing refunds.
Was this section helpful?