The OrderLineItemStatusChanged JSON object is a possible payload of a Webhook Event when the type is ORDER_LINE_ITEM_STATUS_UPDATED.
Please read the Webhook Overview to understand how the Webhook system works.
- Make sure you're familiar with JSON before continuing.
- The JSON objects are defined using Orderly. Optional attrs end with a "?" all others are required.
- isodate fields use one of these ISO 8601 format: 2014-01-01T10:30:00.000+01:00, 2014-01-01T10:30:00.000+0100, 2014-01-01T10:30:00.000Z
- Dsco reserves the right to add new attributes at any time so Partners should ensure their validators won't break should this happen
Definition
Note the definition below references these objects...
Object
{
string eventUuid; # A unique ID representing this event
string status[ # The status of the line item in question
SHIPPED, # Indicates the lineItem in question was shipped
CANCELLED]; # Indicates the lineItem in question was cancelled
ref Order order; # The complete order object that owns the line item
# that now has a newly SHIPPED or CANCELLED line item
array{ref OrderLineItemChange} lineItems; # The line items that newly SHIPPED or were CANCELLED
string trackingNumber?; # If the line items shipped, this is the tracking number of the shipmentt
};
Example
{
"eventUuid": "4b336fe6-dd1a-4e69-910a-914d0b26d213",
"status": "SHIPPED",
"order": {...},
"orderLineItem": {...},
"package": {...}
}
Comments
Please sign in to leave a comment.