The Package JSON object defines a Package within a Shipment of an order in the Dsco system.

Shipping data attributes have changed as of January 2018 - be sure to read the Shipping Data document.

- 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 trackingNumber;            # The package's tracking number
    number shipCost?;                 # The shipping cost of the package
    isodate shipDate?;                # The shipping date of the package
    string shipCarrier?;              # The carrier the supplier used
    string shipMethod?;               # The ship method the supplier used
    array{ref PackageLineItem} items; # The items shipped in the package
    string currencyCode?;             # Added in V2 - the currency of the package
    string shippingServiceLevelCode?;           # Added in V2 - the service level the supplier used
    string dscoActualShipMethod?;               # Added in V2
    string dscoActualShipCarrrier?;
    string dscoActualShippingServiceLevelCode?; # Added in V2
    double dscoActualShipCost?;                 # Added in V2
    isodate dscoActualDeliveryDate?;            # Added in V2
    isodate dscoActualPickupDate?;              # Added in V2
    boolean returnedFlag?;                      # Added in V2
    isodate returnDate?;                        # Added in V2
    string returnNumber?;                       # Added in V2
    string returnReason?;                       # Added in V2
    int numberOfLineItems?;                     # Added in V2
    ref PackageShipFrom packageShipFrom?;       # Added in V2
    ref PackageShipTo packageShipTo?;           # Added in V2
    int dscoPackageId?;                         # Added in V2
    double shipWeight?;                         # Added in V2
    string shipWeightUnits?;                    # Added in V2
    string warehouseCode?;          #Added in V2 - supplier-provided
    string warehouseRetailerCode?;  #Added in V2 - retailer code for 
                                    # supplier's warehouse
    string warehouseDscoId?;        # Added in V2 - Dsco ID of supplier's
                                    # warehouse  
                                    
    string ssccBarcode?;  #Added in V2
};

Example

{
    "trackingNumber": "asfs92342klsdfsf",
    "shipCost": "23.99",
    "shipDate": "2014-01-01T10:15:00+01:00",
    "shipCarrier": "UPS",
    "shipMethod": "GROUND",
    "items":
    [
        <PackageLineItem>,
        <PackageLineItem>
    ]
}
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.