Shipment Data Object

The complete list of keys that may appear on the Shipment Data Object can be found here:
 

How to construct the Shipment Object

Depending on the Shipment or Carrier different fields are needed:

The recommended way is to create the shipment first in Ship and use the Developer tool to inspect the Shipment Object:
Activating and using the Developer Tools

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

Example of a receiver address 

{
    "Kind": 1,
    "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, 
    "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, 
    "CustNo": 0000000, 
    "Street1": "Test Road 1",
    "PostCode": "0580",
    "City": "Oslo",
    "CountryCode": "NO"
}

-
 

LineObject

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 ]
}

-
 

LineReferenceObject | 

Example

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

-
 

ShipmentReferenceObject | 

Example

[ 
    { "Kind": 9, "Value": "2022-02-20" }, 
    { "Kind": 63, "Value": "test" }, 
    { "Kind": 64, "Value": "test" }, 
    { "Kind": 108, "Value": "2022-02-21T00:00:00" }, 
    { "Kind": 109, "Value": "2022-02-22T04:00:00" }, 
    { "Kind": 110, "Value": "2022-02-23T00:00:00" },
    { "Kind": 111, "Value": "2022-02-24T00:00:00" }    
]

-
 

DetailGroupObject | 
 

Example UPS

{
    "DetailGroups": [
      { CustomsArticleInfoObject },
      { CustomsInfoObject }
    ]
}

Example Fedex

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

Example DHL

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

CustomsArticleInfoObject | 

Example

{
    "GroupID": 1, // Article Info
    "Rows": [{
            "LineNo": 1, // Link To Line 1
            "Details": [
                { "KindID": 5, "Value": "1" },
                { "KindID": 8, "Value": "KG"}, 
                { "KindID": 7, "Value": "Item 1" }
                { "KindID": 4, "Value": "DK" }, 
                { "KindID": 2, "Value": "100,00" }, 
                { "KindID": 1, "Value": "123456" },
                { "KindID": 18, "Value": "123456" }, 
                { "KindID": 17, "Value": "DKK" },
                { "KindID": 10, "Value": "100,00" }, 
                { "KindID": 9, "Value": "10,00" } 
           ]
        }, {
            "LineNo": 1,
            "Details": [
                    { "KindID": 5, "Value": "1" }, 
                    { "KindID": 8, "Value": "KG"}, 
                    { "KindID": 7, "Value": "Item 2" }, 
                    { "KindID": 4, "Value": "DK" }, 
                    { "KindID": 2, "Value": "120,00" },
                    { "KindID": 1, "Value": "123456" }, 
                    { "KindID": 18, "Value": "123456" },
                    { "KindID": 17, "Value": "DKK" }, 
                    { "KindID": 10, "Value": "120,00" }, 
                    { "KindID": 9, "Value": "12,00" } 
                ]
        }, {
            "LineNo": 2,
            "Details": [
                    { "KindID": 5, "Value": "1" },
                    { "KindID": 8, "Value": "KG" }, 
                    { "KindID": 7, "Value": "Some other Item" }, 
                    { "KindID": 4, "Value": "DK" }, 
                    { "KindID": 2, "Value": "100,00" },
                    { "KindID": 1, "Value": "123456" },
                    { "KindID": 18, "Value": "123456" },
                    { "KindID": 17, "Value": "DKK" },
                    { "KindID": 10, "Value": "100,00" },
                    { "KindID": 9, "Value": "5,00" }
            ]
        }
    ]
}

CustomsInfoObject | 

Example

FedExCustomsInformationObject | 

Example

DHLFilingObject | 

Example

OrderDataObject | 

Example

 -

Appendix

• Shipment Objects
  • Address
  • Lines
  • LineUnit
  • Package
  • Reference
  • ShpConnection
  • Detail
  • Row
  • DetailGroup
  • Amount
  • Message
  • DangerousGoods
  • CSEvent
  • Label
• Enums
  • AddressKind
  • ShipmentKind
  • ReferenceKind
  • ShipmentAmountKind
  • ShipmentMessageKind
  • CarrierPayer
  • ShipmentTemperature
  • DGClass
  • DGKind
  • DGMarinePollutant
  • DGPackingGroup
  • DetailGroupKind
  • DetailKind
  • ShipmentConnectionKind
  • ConsignorEventKind
• Currency codes
• Diagram showing associations between classes

-

Shipment Data Object | Top level keys

Address Object | Included in the Addresses array in the Shipment object

Line Object | Included in the Lines array in the Shipment object

LineUnit | Included in the LineUnits array in the Line object.

Package Object |

Reference | Included in the References arrays in the Shipment object and the Lines object

ShpConnection | included in the ShpConnections array in the Shipment object

Detail | included in the Details array in the Row and DetailGroup objects)

Row | Included in the Rows array in the DetailGroup object

DetailGroup | Included in the DetailGroups array in the Shipment object

Amount | Included in the Amounts array in the Shipment object

Message | Included in the Messages array in the Shipment object

DangerousGoods | Included in the DangerousGoods array in the Shipment object

CSEvent | Included in the CSEvents array in the Shipment object)