Shipment Data Object

Work in progress

Old documentation for the data object can be found here:
https://helpcenter.nshift.com/hc/en-us/articles/360003165473

How to construct the Shipment Object

Depending on the Shipment or Carrier different fields are needed:

Recommended way is to create the shipment first in Ticket and use the Developer tool to inspect the Shipment Object:
https://helpcenter.nshift.com/hc/en-us/articles/6408142649884

Alternatively, you can also construct it yourself using some of the following keys:

{
    "OrderNo": "STRING",
    "PickupDt": "2022-11-30T00:00:00",
    "ProdConceptID": "INT",
    "Addresses": [ AddressObject ],
    "References": [ ShipmentReferenceKind ],
    "Amounts": [ AmountObject ],
    "Messages": [ MessageObject ],
    "Lines": [ LineObject ],
    "DangerousGoods": [ DangerousGoodsObject ],
    "DetailGroups": [ DetaiGroupObject ],
    "Services": [ AddOnsIds ]
}

OrderNo - String
PickupDt - ISO Date
ProdConceptID - the id of a service / product
Addresses - see the section about the AddressObject
References - see the section about the ShipmentReferenceKind
Amounts - see the section about the
Messages - see the section about the
Lines - see the section about the LineObject
DangerousGoods - see the section about the
DetailGroups - see the section about the DetaiGroupObject

AddressObject

The Kind is what defines the type of address:

1 - Receiver
2 - Sender
3 - PickUp
4 - Payer
5 - Buyer
8 - Forwarder
9 - ReturnTo
10 - DropPoint
11 - Depot
13 - Broker
14 - Delivery
16 - Import

Not all fields are mandatory on all address types

Kind - enum
Name1 - string
Name2 - string
Street1 - string
Street2 - string
State - string
PostCode - string
City - string
POBox - string
POPostCode - string
POCity - string
Phone - string
Mobile - string
Email - string
Attention - string
CustNo - string
Fax - string
CountryCode - ISO 3166 country code, 2 letters (DK, NO)
Province - string
ERPRef - string
OpeningHours - string
VATNo - string
VOECNumber - string

Example of a receiver address

{
    "Kind": 1, // 1 = receiver
    "Name1": "Test Receiver Name1",
    "Street1": "Test Road 1",
    "PostCode": "0580",
    "City": "Oslo",
    "Phone": "12341234",
    "Mobile": "12341234",
    "Email": "noreply@nshift.com",
    "Attention": "Test Attention",
    "CountryCode": "NO"
}

Example of a sender address

{
    "Kind": 2, // 2 = sender
    "Name1": "Test Receiver Name1",
    "Street1": "Test Road 1",
    "PostCode": "0580",
    "City": "Oslo",
    "Phone": "12341234",
    "Mobile": "12341234",
    "Email": "noreply@nshift.com",
    "Attention": "Test Attention",
    "CountryCode": "NO"
}

Example of a droppoint address

{
    "Kind": 10, // 10 = droppoint
    "CustNo": 0000000, // DropPoint ID
    "Street1": "Test Road 1",
    "PostCode": "0580",
    "City": "Oslo",
    "CountryCode": "NO"
}

#DataObject

LineObject

The full list of supported keys can be found here

Example

{
    "Number": 1, // number of labels to create on the goodsline
    "PkgWeight": 10000, // in gram
    "Height": 100, // in mm
    "Length": 100, // in mm
    "Width": 100, // in mm
    "GoodsTypeKey1": "CLL", // the key of the goodstype
    "References": [ LineReferenceKind ]
}

#DataObject

LineReferenceKind

The full list of supported keys can be found here

Example

[ 
    { "Kind": 23, "Value": "" }, // Line Content
    { "Kind": 24, "Value": "" }, // Line Marking
    { "Kind": 129, "Value": "" }, // Line Custom field 1   
    { "Kind": 225, "Value": "" } // Line Custom field 10
]

#DataObject

ShipmentReferenceKind

The full list of supported keys can be found here

Example

[ 
    { "Kind": 9, "Value": "2022-02-20" }, // Delivery Date
    { "Kind": 63, "Value": "test" }, // Custom Field 1
    { "Kind": 64, "Value": "test" }, // Custom Field 2    
    { "Kind": 108, "Value": "2022-02-21T00:00:00" }, // Pickup Start     
    { "Kind": 109, "Value": "2022-02-22T04:00:00" }, // Pickup End
    { "Kind": 110, "Value": "2022-02-23T00:00:00" },  // Delivery Start
    { "Kind": 111, "Value": "2022-02-24T00:00:00" } // Delivery End
    
]

#DataObject

DetailGroupObject

Example

{
    "DetailGroups": [
        { CustomsArticleInfoObject },
        { CustomsInfoObject },
        { FedExCustomsInformationObject },
        { DHLFilingObject },
        { OrderDataObject }
    ]
}

#DataObject

CustomsArticleInfoObject

Example

{
    "GroupID": 1, // Article Info
    "Rows": [{
            "LineNo": 1, // Link To Line 1
            "Details": [
                { "KindID": 5, "Value": "1" }, // No units
                { "KindID": 8, "Value": "KG"}, // Unit of Measure (code)
                { "KindID": 7, "Value": "Item 1" }, // Description of goods
                { "KindID": 4, "Value": "DK" }, // Country of Origin
                { "KindID": 2, "Value": "100,00" }, // Unit Value
                { "KindID": 1, "Value": "123456" }, // Article No
                { "KindID": 18, "Value": "123456" }, // Commodity Code
                { "KindID": 17, "Value": "DKK" }, // Currency
                { "KindID": 10, "Value": "100,00" }, // Total Value
                { "KindID": 9, "Value": "10,00" } // Total Weight
           ]
        }, {
            "LineNo": 1, // Link To Line 1
            "Details": [
                    { "KindID": 5, "Value": "1" }, // No units
                    { "KindID": 8, "Value": "KG"}, // Unit of Measure (code)
                    { "KindID": 7, "Value": "Item 2" }, // Description of goods
                    { "KindID": 4, "Value": "DK" }, // Country of Origin
                    { "KindID": 2, "Value": "120,00" }, // Unit Value
                    { "KindID": 1, "Value": "123456" }, // Article No
                    { "KindID": 18, "Value": "123456" }, // Commodity Code
                    { "KindID": 17, "Value": "DKK" }, // Currency
                    { "KindID": 10, "Value": "120,00" }, // Total Value
                    { "KindID": 9, "Value": "12,00" } // Total Weight
                ]
        }, {
            "LineNo": 2, // Link To Line 2
            "Details": [
                    { "KindID": 5, "Value": "1" }, // No units
                    { "KindID": 8, "Value": "KG" }, // Unit of Measure (code)
                    { "KindID": 7, "Value": "Some other Item" }, // Description of goods
                    { "KindID": 4, "Value": "DK" }, // Country of Origin
                    { "KindID": 2, "Value": "100,00" }, // Unit Value
                    { "KindID": 1, "Value": "123456" }, // Article No
                    { "KindID": 18, "Value": "123456" }, // Commodity Code
                    { "KindID": 17, "Value": "DKK" }, // Currency
                    { "KindID": 10, "Value": "100,00" }, // Total Value
                    { "KindID": 9, "Value": "5,00" } // Total Weight
            ]
        }
    ]
}