The OrderLineItem JSON object defines an item within an Order in the Dsco system.
- 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
Object
{
int dscoSupplierId?; # The supplier of this item
int dscoItemId?; # The Dsco unique ID of the item, if sku
# is not present then this attar is required
string sku?; # The SKU of the item, if dscoItemId is not
# present then this attr is required
string title?; # The title of the item
int quantity; # The number of this item in the order
number expectedCost?; # The expected cost of the item
number consumerPrice?; # The consumer's price for this item
string personalization?; # Personalization info for this item
string warehouseCode?; # Added in V2 - the warehouse of the item
string status?; # Added in V2 - the status of the line item
# (accepted, rejected, cancelled);
# iff some of the quantity of the order but
# not all has been cancelled or rejected then
# the order may continue to be shipped; however,
# if all of the quantity of the order has been
# cancelled or rejected then the status will be
# cancelled; if this status has a value but
# cancelledQuantity, acceptedQuantity and
# rejectedQuantity are not set then this
# status applies to the entire quantity of the
# line item or to the portion of the quantity
# not expressly cancelled, rejected or accepted
# via cancelledQuantity, rejectedQuantity and
# acceptedQuantity respectively
# compared to overall quantity to determine
# line item status
string statusReason?; # Added in V2 - the last known reason
# for the status to change
int cancelledQuantity?; # Added in V2 - if present and non-zero then
# this is the quantity of the item that has
# been cancelled by the supplier; if this
# quantity is less than the total quantity of
# the item then look to acceptedQuantity and
# rejectedQuantity to know the status of the
# remainder of the quantity
string cancelledReason?; # Added in V2 - the optional reason that some
# quantity was cancelled by the supplier
int acceptedQuantity?; # Added in V2 - if present and non-zero then
# this is the quantity of the item that has
# been accepted; if this quantity is less than
# the total quantity of the item then look to
# cancelledQuantity and rejectedQuantity to
# know the status of the remainder of the
# quantity
string acceptedReason?; # Added in V2 - the optional reason that some
# quantity was accepted
int rejectedQuantity?; # Added in V2 - if present and non-zero then
# this is the quantity of the item that has
# been rejected by the retailer; if this
# quantity is less than the total quantity of
# the item then look to cancelledQuantity and
# rejectedQuantity to know the status of the
# remainder of the quantity
string rejectedReason?; # Added in V2 - the optional reason that some
# quantity was rejected by the retailer
};
Example
{
"dscoItemId": 8276,
"sku": "aa832934",
"title": "My Item",
"quantity": 3,
"expectedCost": 23.99,
"consumerPrice": 26.99,
"personalization": "Personalization data here...",
"warehouseCode": "EASTV1",
"status": "cancelled"
}
Comments
0 comments
Please sign in to leave a comment.