The Shipment JSON object specifies a shipment of an order in the Dsco system.

Dsco changed shipping data attributes as of January 2018 - please read the Shipping Data document that explains these changes.

- 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
{
    string poNumber;              # The poNumber of the shipment's order
    string supplierOrderNumber;   # The supplier's unique ID for the
                                    shipment's order
    string consumerOrderNumber?;  # Added in V2
    array{ref Package} packages;  # The packages comprising the order

    int dscoOrderId ?;            # Dsco unique ID for order of shipment
    string dscoOrderStatus?;      # Dsco order status
    int dscoRetailerId;           # Dsco retailer account ID of the order
    int dscoSupplierId;           # Dsco supplier account ID of the order
    isodate dscoCreateDate ?;     # Dsco date order was created
    isodate dscoLastUpdateDate?;  # Dsco date order was last updated
    string currencyCode?;         # Added in V2 - currency code
    
    string dscoRetailerName?;              # Added in V2
    string dscoSupplierName?;              # Added in V2
    string dscoTradingPartnerId?;          # Added in V2
    string dscoTradingPartnerName?;        # Added in V2
    isodate retailerExpectedDeliveryDate?; # Added in V2
    isodate retailerRequiredDeliveryDate?; # Added in V2
    
    # Dsco changed shipping data attributes of January 2018, please
    # be sure you've read the Shipping Data doc referenced at the 
    # top of the page do understand what these shipping data 
    # attributes mean.
    
    string shipCarrier?;                      # Added in V2 
    string shipMethod?;                       # Added in V2
    string shippingServiceLevelCode?;         # Added in V2
    string retailerShipCarrier?;              # Added in V2 
    string retailerShipMethod?;               # Added in V2
    string retailerShippingServiceLevelCode?; # Added in V2
    string dscoShipCarrier?;                  # Added in V2 
    string dscoShipMethod?;                   # Added in V2
    string dscoShippingServiceLevelCode?;     # Added in V2
    
};

Example

{
    "poNumber": "ssd2342",
    "supplierOrderNumber": "929238",
    "packages":
    [
        <Package>,
        <Package>
    ],
    "dscoOrderId": 32255,
    "dscoOrderStatus": "shipped",
    "dscoRetailerId": 34277,
    "dscoSupplierId": 8225,
    "dscoCreateDate": "2014-01-01T10:15:00+01:00",
    "dscoLastUpdateDate": "2014-01-01T10:15:00+01:00",
    "currencyCode": "USD",
    "shipCarrier": "USP",
    "shipMethod": "GROUND",
    "shippingServiceLevelCode": "2"

}
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.