| Shipment Object | ||||
|---|---|---|---|---|
| Name | Object-Type | Required | Description | Allowed Values and Business Rules |
| Account | ShipperAccount-Object | Required | Coll-8 Shipping Account Code | Shipping Account must be active in the Coll-8 system |
| TrackingNumber | nvarchar(30) | Not Required | COLL-8 Logistics Shipment TrackingNumber | Coll-8 will generate a TrackingNumber for the Shipment if no TrackingNumber is provided. Where a TrackingNumber is provided it must meet Coll-8 TrackingNumber specification and Module10 check digit verification |
| ServiceType | nvarchar(30) | Required | Type of Shipment | Reference Data - Service Type |
| PUDOCode | nvarchar(15) | Not Required | PUDO Location Code for Drop2Shop Services | Must be populated with a valid active PUDO Code if the Shipment Service Type is a PUDO Shipment e.g. drop2Shop-Return, drop2Shop-Collect |
| GoodsDescription | nvarchar(500) | Not Required | Description of the Shipment | |
| UOMWeight | nvarchar(3) | Required | Units of Measure - Weight | Reference Data: Weights And Dimensions - Units Of Measure - Weight |
| Weight | decimal(10,3) | Required | Total Shipment Weight, including packaging | |
| ShippingDate | date | Required | Shipping Date | Format: YYYY-MM-DD Must be > today -7 days and less than today +14 days |
| NumberOfPackages | integer | Required | Number of Packages | 1 to 10 |
| References | ShipmentReference-Object | Not Required | Shipper/ 3rd Party References & TrackingNumbers | |
| Addresss | Address-Object | Required | Collection of Shipping Address | ShipTo, ShipFrom, PUDO |
| Packages | Package-Object | Required | Collection of packages | |
| SignatureServices | ServiceOptions-Object | Required | Collection of services allowed on the shipment | Reference Data - Service Options |
| RetailerInvoice | RetailerInvoice-Object | Required for Customs | Retailer Invoice details | |
Go to top
| ShipperAccount Object | ||||
|---|---|---|---|---|
| Data Type | Object-Type | Required | Description | Allowed Values and Business Rules |
| AccountCode | nvarchar(15) | Required | Coll-8 Logistics Account Code | Must be an active Coll-8 Logistics account code |
Go to top
| ShipmentReference Object | ||||
|---|---|---|---|---|
| Data Type | Object-Type | Required | Description | Allowed Values and Business Rules |
| ReferenceType | nvarchar(32) | Required | Reference Type | Reference Data: Reference Type |
| ReferenceValue | nvarchar(32) | Required | Reference Value | |
Go to top
| Address Object | |||||
|---|---|---|---|---|---|
| Data Type | Object-Type | Required | Description | Allowed Values and Business Rules | |
| Address | |||||
| AddressType | nvarchar(15) | Required | ShipTo, ShipFrom, PUDO | Reference Data - Address Type | |
| AddressLocationType | nvarchar(15) | Not Required | Business, Residential | Reference Data - Address Location Type | |
| CompanyName | nvarchar(50) | Not Required | Required if Address Location Type is Business | ||
| AddressLine1 | nvarchar(100) | Required | |||
| AddressLine2 | nvarchar(100) | Not Required | |||
| AddressLine3 | nvarchar(100) | Not Required | |||
| City | nvarchar(60) | Required | |||
| State | nvarchar(60) | Required | State / County / Region | Required for Ireland Must be a valid County in Ireland for Ireland address Reference Data - Ireland County List | |
| PostCode | nvarchar(15) | Required | Valid Eircode for Ireland address | ||
| Country | nvarchar(60) | Required | ISO 3166-1 Country | Either Country or Country Code must be supplied Reference Data: Country Codes |
|
| CountryCode | nvarchar(30) | Required | ISO 3166-1 Country | Either Country or Country Code must be supplied Reference Data: Country Codes |
|
| PhoneNumber | nvarchar(30) | Not Required | |||
| nvarchar(60) | Not Required | ||||
| GPSCoordinates | nvarchar(30) | Not Required | |||
| EORINumber | nvarchar(30) | Required for Customs | Economic Operators Registration and Identification system (EORI) | Required for Customs Shipments e.g. Required on Ship From address for shipments from UK to IE |
|
| Contact | Contact-Object | Required | |||
Go to top
| Contact Object | ||||
|---|---|---|---|---|
| Data Type | Object-Type | Required | Description | Allowed Values and Business Rules |
| ContactName | nvarchar(60) | Required | Recipient name | Depends on Service Type and Address Type e.g. Required for drop2shop-Collect for ShipTo address (consumer name) Required for drop2shop-Return for ShipFrom address (consumer name) |
| PhoneNumber | nvarchar(30) | Not Required | ||
| nvarchar(60) | Required | Valid email address Depends on Service Type and Address Type e.g. Required for drop2shop-Collect for ShipTo address (consumer email address) Required for drop2shop-Return for ShipFrom address (consumer email address) |
||
| MobileNumber | nvarchar(30) | Required | Mobile number in International format e.g. 353870000000 for Ireland |
Valid mobile number Depends on Service Type and Address Type e.g. Required for drop2shop-Collect for ShipTo address (consumer mobile number) Required for drop2shop-Return for ShipFrom address (consumer mobile number) |
Go to top
| Package Object | ||||
|---|---|---|---|---|
| Data Type | Object-Type | Required | Description | Allowed Values and Business Rules |
| PackageTrackingNumber | nvarchar(30) | Not Required | Package Tracking Number | Coll-8 will generate a PackageTrackingNumber for the Shipment if no PackageTrackingNumber is provided. Where a PackageTrackingNumber is provided it must meet Coll-8 PackageTrackingNumber specification and Module10 check digit verification |
| PackageItemNumber | integer | Not Required | Package Item Number | |
| Description | nvarchar(300) | Not Required | Package Description | |
| PackagingType | nvarchar(15) | Required for Customs | Type of Packaging | Reference Data: Package Type |
| TrackingNumber3rdParty | nvarchar(30) | Not Required | Integrator / Broker Reference (Alternate Reference) |
|
| ShipperTrackingNumber | nvarchar(30) | Not Required | Retailer Reference (Alternate Reference) |
|
| UOMWeight | nvarchar(2) | Required | Units Of Measure - Weight | Reference Data: Weights And Dimensions - Units of Measure - Weight |
| Weight | decimal(10,2) | Required | Package Weight Gross Weight of the Package, including packaging |
Must be greater than 0.00. Depends on Service Type. drop2Shop-Return and drop2Shop Collect max 10kg for a single package drop2me max 30 kg for a single package |
| NettWeight | decimal(10,2) | Not Required | Nett Mass Weight. Nett Weight of package contents without packaging |
Cannot be greater than Package Weight |
| UOMDimensions | nvarchar(3) | Required | Units Of Measure - Dimensions | Reference Data: Weights And Dimensions - Units of Measure - Dimensions |
| Width | decimal(10,2) | Not Required | Shortest side | |
| Height | decimal(10,2) | Not Required | Middle Side | |
| Depth | decimal(10,2) | Not Required | Longest Side | |
| CurrencyCode | nvarchar(3) | Not Required | Reference Data: Currency Codes | |
| Value | decimal(10,3) | Not Required | ||
| PackageItems | PackageItem-Object | Required for Customs | List of items in the package | |
Go to top
| Package Item Object | ||||
|---|---|---|---|---|
| Data Type | Object-Type | Required | Description | Allowed Values and Business Rules |
| GoodsDescription | nvarchar(300) | Required for Customs | Description of the item in the package | |
| CountryOfOrigin | nvarchar(3) | Required for Customs | ISO 3166-1 Country Code | Reference Data: Country Code |
| ProductCode | nvarchar(50) | Not Required | Your product code for the item | |
| SKUCode | nvarchar(50) | Not Required | SKU Code | |
| HSCode | nvarchar(15) | Required for Customs | Customs Harmonization Code/Commodity Code | |
| Quantity | integer | Required for Customs | Number of items of HSCode type | Greater than 0 and Less than or equal to 99999 |
| Value | decimal(10,3) | Required for Customs | Value/Cost of an single item of HSCode type | Greater than 0 and Less than or equal To 999999.99 |
| UOMWeight | nvarchar(2) | Required for Customs | Units Of Measure - Weight | Reference Data: Weights And Dimensions - Units of Measure - Weight |
| Weight | decimal(10,2) | Required for Customs | Gross Mass Weight. Weight of an single item of HSCode type with packaging |
Depends on Service Type. drop2Shop-Return and drop2Shop Collect max 10kg for a single package drop2me max 30 kg for a single package |
| NettWeight | decimal(10,2) | Not Required | Nett Mass Weight. Nett Weight of an single item of HSCode type without packaging |
Cannot be greater than Item Weight |
| UOMDimensions | nvarchar(3) | Not Required | Units Of Measure - Dimensions | Reference Data: Weights And Dimensions - Units of Measure - Dimensions |
| Width | decimal(10,2) | Not Required | Shortest side | |
| Height | decimal(10,2) | Not Required | Middle Side | |
| Depth | decimal(10,2) | Not Required | Longest Side | |
| InvoiceAmount | decimal(10,3) | Required for Customs | Invoice Amount for items of HSCode type (Quantity x Value) |
Greater than 0 and Less than or equal To 999999.99 |
| PackagingType | nvarchar(15) | Required for Customs | Type of packaging of an single item of HSCode type | Reference Data: Item Package Type |
| CommodityNational | nvarchar(5) | Required for Customs | Customs Commodity VAT code | VATS - Standard VAT Rate VATZ - Zero VAT Rate |
Go to top
| Service Options | ||||
|---|---|---|---|---|
| Data Type | Object-Type | Required | Description | Allowed Values and Business Rules |
| Service | nvarchar(30) | Required | Reference Data - Service Options | |
Go to top
| RetailerInvoice Object | ||||
|---|---|---|---|---|
| Data Type | Object-Type | Required | Description | Allowed Values and Business Rules |
| InvoiceNumber | nvarchar(35) | Required for Customs | Your Invoice Number for the Shipment | |
| CurrencyCode | nvarchar(3) | Required for Customs | Currency code for the Invoice (Total Amount, Shippping Cost, Shipping Insurance Cost) |
Reference Data: Currency Codes |
| TotalAmount | decimal(10,2) | Required for Customs | Total Invoice Amount for the shipment | Greater than 0 and Less Than or Equal To 999999.99 |
| ShippingCost | decimal(10,2) | Required for Customs | Shipping Costs for the shipment | Default to 0 if there are no Shipping Costs |
| ShippingInsuranceCost | decimal(10,2) | Required for Customs | Shipping Insurance Costs for the shipment | Default to 0 if there are no Shipping Insurance Costs |
| RetailerOSSAccountCode | nvarchar(32) | Optional | Customs One Stop Shop Account Code/Number | |
Go to top