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
Example on the top level keys when defining the shipment object
{
"ProdConceptID": 0, // the id of a service
"OrderNo": "", // an order number
"Addresses": [ AddressObject ], // a list of addresses
"Lines": [ LineObject ], // a list of goodslines
"References": [ ShipmentReferenceKind ], // a list of references
"DetailGroups": [ DetaiGroupObject ], // custom information
"Services": [ AddOnsIds ] // a list of add-ons to activate on a service
}
-
AddressObject
The Kind is what defines the type of address, see the complete list here
The full list of supported keys can be found here
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",
}
-
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 ]
}
-
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
]
-
ShipmentReferenceKind
The full list of supported keys can be found here
Example
[
{ "Kind": 9, "Value": "2022-02-03" }, // Delivery Date
{ "Kind": 63, "Value": "test" }, // Custom Field 1
{ "Kind": 64, "Value": "test" }, // Custom Field 2
{ "Kind": 108, "Value": "2022-02-01T00:00:00" }, // Pickup Start
{ "Kind": 109, "Value": "2022-02-02T04:00:00" }, // Pickup End
{ "Kind": 110, "Value": "2022-02-03T00:00:00" }, // Delivery Start
{ "Kind": 111, "Value": "2022-02-04T00:00:00" } // Delivery End
]
-
DetailGroupObject
Example
{
"DetailGroups": [
{ CustomsArticleInfoObject },
{ CustomsInfoObject },
{ FedExCustomsInformationObject },
{ DHLFilingObject },
{ OrderDataObject }
]
}
-
CustomsArticleInfoObject
Example
{
"GroupID": 1, // Article Info
"Rows": [{
"RowNo": 1, // Row Index
"LineNo": 1, // Link To Line Index + 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
{ "KindID": 193, "Value": "1" } // Goods Line No
]
}, {
"RowNo": 2, // Row Index
"LineNo": 1, // Link To Line Index + 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
{ "KindID": 193, "Value": "1" } // Goods Line No
]
}, {
"RowNo": 1, // Row Index
"LineNo": 2, // Link To Line Index + 1
"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
{ "KindID": 193, "Value": "2" } // Goods Line No
]
}
]
}
-
CustomsInfoObject
Example
-
FedExCustomsInformationObject
Example
-
DHLFilingObject
Example
-
OrderDataObject
Example