...
Name | Mandatory | Description | Max length | Type | Example |
---|---|---|---|---|---|
EXTERNAL_ORDER_ID | External order ID | 12 | String | A345 | |
CONSIGNEE_EXT_ID | Customer ID | n/a | Integer | 78899 | |
CONSIGNEE_NAME | Yes | Name of customer | 105 | String | Ola Nordmann |
CONSIGNEE_COUNTRYCODE | Yes | Country code, according to ISO 3166-1. | 3 | String | NO |
CONSIGNEE_ADDRESS | Combined address information with the following format:
| 105 | String | Storgaten 11A H0202 | |
CONSIGNEE_CO | "Care Of"-address. Adding "c/o" (or similar) is not necessary. | ||||
CONSIGNEE_ZIPCODE | Yes | Also known as postal code. | 9 | String | 0155 |
CONSIGNEE_POSTAL_NAME | Yes | Also known as city. | 35 | String | OSLO |
CONSIGNEE_PHONE_1 | This can be used for automated SMS notification. | 100 | String | +47 402 10 000 | |
CONSIGNEE_PHONE_2 | This can be used for automated SMS notification. | 100 | String | +47 402 20 000 | |
CONSIGNEE_EMAIL | This can be used for automated email notification. | 100 | String | ola@nordmann.no | |
CONSIGNEE_REFERENCE | This can be an orderId or some other reference. Consignee reference can be placed on some shipping labels. | 35 | String | 012345 | |
CONSIGNOR_NAME | Yes | Name of customer | |||
CONSIGNOR_COUNTRYCODE | Yes | Country code, according to ISO 3166-1. | |||
CONSIGNOR_ADDRESS | Combined address information with the following format:
| ||||
CONSIGNOR_CO | "Care Of"-address. Adding "c/o" (or similar) is not necessary. | ||||
CONSIGNOR_ZIPCODE | Yes | Also known as postal code. | |||
CONSIGNOR_POSTAL_NAME | Yes | Also known as city. | |||
CONSIGNOR_PHONE_1 | This can be used for automated SMS notification. | ||||
CONSIGNOR_PHONE_2 | This can be used for automated SMS notification. | ||||
CONSIGNOR_EMAIL | This can be used for automated email notification. | ||||
CONSIGNOR_REFERENCE | This can be an orderId or some other reference. Consignor reference can be placed on some shipping labels. | 35 | String | 012345 | |
WEIGHT | Measuring unit is gram. | n/a | Whole number | 600 | |
VOLUME | Measuring unit is cubic decimeter. | n/a | Decimal number | 4 | |
LENGTH | Measuring unit is centimeter. | n/a | Decimal number | 120 | |
HEIGHT | Measuring unit is centimeter. | n/a | Decimal number | 5 | |
WIDTH | Measuring unit is centimeter. | n/a | Decimal number | 12 | |
CONTENT | Description of the contents. This can be placed on some shipping labels. | 70 | String | Brown shirt | |
CONTENT_VALUE | Currency is according to the location of the shopId. | n/a | Decimal number | 580 | |
GENERIC_1 | A piece of generic information that will be retained through the process and given back in the resulting file. | Text | |||
GENERIC_2 | A piece of generic information that will be retained through the process and given back in the resulting file. | Text | |||
GENERIC_3 | A piece of generic information that will be retained through the process and given back in the resulting file. | Text | |||
GENERIC_4 | A piece of generic information that will be retained through the process and given back in the resulting file. | Text | |||
GENERIC_5 | A piece of generic information that will be retained through the process and given back in the resulting file. | Text | |||
ADDITIONAL_SERVICE_CODE | No | Code of the additional service | 3 | String | ASB |
ADDITIONAL_SERVICE_VALUE | No | Value of the additional service | 10 | String | HHWMS |
ARTICLE_NUMBER | Yes ( If additional service is used ) | Number of the article ( Must be ; separated. See the example ) | 35 ( For each article number ) | String | 9055568;9055569;9055570 |
ARTICLE_NAME | Yes ( If additional service is used ) | Name of the article ( Must be ; separated. See the example ) | 100 ( For each article name ) | String | DataSIM1;DataSIM2;DataSIM3 |
ARTICLE_QUANTITY | Yes ( If additional service is used ) | Quantity of the article ( Must be ; separated. See the example ) | 3 ( For each article quantity ) | String | 10;25;15 |
DESIRED_DELIVERY_DATE | No | Date format yyyyMMdd. Optional field for desired delivery date of the shipment. Â If specified for return solutions this day represents the date where the carrier should pickup the package and should be earliest tomorrow. Normally the consignor / sender will be instructed to lay out the package the day before pickup. | 8 | String | 20180804 |
SHIPMENT_ID | No | If not specified as a part of the request this will be generated and returned in the response. This should be a globally unique identifier. Typically named MessageNumber, DocumentNumber or ConsignorsReference in EDI. | 35 | String | (401)70712190172720651 |
TRACKING_REFERENCE | No | If not specified as a part of the request this will be generated and returned in the response. This can be a SSCC code according to gs1, or a UPU S10 identifier. Typically named TransporterInstructionMark in EDI. Â For return solutions this field should never be set by the callee. Tracking refernce for return packages is generated by DI and returned in the response. | 35 | String | (00)370724760010119754 |
Template-file and examples
...