Label Description
Because each carrier has a different style of the label and the location of the content displayed on the label, it is necessary to sort out this document to facilitate the docking of the shipment API.
In the future, we will connect with new carriers, and this document will continue to add instructions for the carrier's label sheet.
The mapping relationship between the content displayed on the form of each carrier and the input field of the shipment API is as follows:
FedEx
ServiceType: FEDEX_GROUND(FedEx Ground)
Logistics Center Interface Fields | Label Position | Interface Field Description (From logistics website API docs) | Content Example | Business Data/Logistics Company (Distinguishes between our business data and logistics provider data) |
---|---|---|---|---|
shipper.contact.personName | 1 | Specify contact name. Maximum length is 70. Note: Either the companyName or personName is mandatory. | ShipperPersonName | Business Data |
shipper.contact.companyName | 2 | Specify contact company name. Maximum length is 35. Note: Either the companyName or personName is mandatory. | shipperContactCompany | Business Data |
shipper.address.streetLine1 | 3 | Combination of number, street name, etc. At least one line is required for a valid physical address. Empty lines should not be included. Max Length is 35. | ShipperStreetLine1 | Business Data |
shipper.address.streetLine2 | 4 | Combination of number, street name, etc. At least one line is required for a valid physical address. Empty lines should not be included. Max Length is 35. | ShipperStreetLine2 | Business Data |
shipper.address.city shipper.address.stateOrProvinceCode shipper.address.zipCode | 5 | The name of city, town of the recipient.Max length is 35. The US States,Canada and Puerto Rico Province codes of the recipient. The Format and presence of this field may vary depending on the country. This is the postal code. Note: This is Optional for non postal- aware countries. Maximum length is 10. | La Puente CA 91746 | Business Data |
shipper.address.countryCode | 6 | This is the two-letter country code. | US | Business Data |
shipper.contact.phoneNumber | 7 | The shipper's phone number. Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers. | 1234561234 | Business Data |
itemLine[0].weight | 8 | These are the package weight details. Note: Weight is not required for One rate shipments | 22.5 LB | Business Data |
itemLine[0].dimensions | 9 | Indicate the dimensions of the package. | 6.5 * 7.6 * 2.3 IN | Business Data |
recipient.contact.personName | 10 | Specify contact name. Maximum length is 70. Note: Either the companyName or personName is mandatory. | RecipientPersonName | Business Data |
recipient.contact.companyName | 11 | Specify contact company name. Maximum length is 35. Note: Either the companyName or personName is mandatory. | RecipientCompanyName | Business Data |
recipient.address.streetLine1 | 12 | Combination of number, street name, etc. At least one line is required for a valid physical address. Empty lines should not be included. Max Length is 35. | RecipientStreetLine1 | Business Data |
recipient.address.city recipient.address.stateOrProvinceCode recipient.address.zipCode | 13 | The name of city, town of the recipient.Max length is 35. The US States,Canada and Puerto Rico Province codes of the recipient. The Format and presence of this field may vary depending on the country. This is the postal code. Note: This is Optional for non postal- aware countries. Maximum length is 10. | Beverly Hills CA 90210 | Business Data |
recipient.address.countryCode | 14 | This is the two-letter country code. | US | Business Data |
recipient.contact.phoneNumber | 15 | The shipper's phone number. Minimum length is 10 and supports maximum of 15 for certain countries using longer phone numbers. Note: For US and CA, a phone number must have exactly 10 digits, plus an optional leading country code of '1' or '+1'. | 1234561234 | Business Data |
itemLine[0].customerReference.ref3 | 16 | This is a customer reference type. The value specified here for the element is printed on the Commercial Invoice only for tracking and label information. | reference3 | Business Data |
itemLine[0].customerReference.ref2 | 17 | This is a customer reference type. The value specified here for the element is printed on the Commercial Invoice only for tracking and label information. | reference2 | Business Data |
itemLine[0].customerReference.ref5 | 18 | This is a customer reference type. The value specified here for the element is printed on the Commercial Invoice only for tracking and label information. | reference5 | Business Data |
itemLine[0].customerReference.ref1 | 19 | This is a customer reference type. The value specified here for the element is printed on the Commercial Invoice only for tracking and label information. | reference1 | Business Data |
itemLine[0].customerReference.ref4 | 20 | This is a customer reference type. The value specified here for the element is printed on the Commercial Invoice only for tracking and label information. | reference4 | Business Data |
recipient.address.zipCode | 21 | This is the postal code. Note: This is Optional for non postal- aware countries. Maximum length is 10. | 90210 | Business Data |
paymentOption.paymentType | 22 | Specifies the payment Type | SENDER | Business Data |
The following is the specific label style.
UPS
ServiceType: 03(UPS Ground)
Logistics Center Interface Fields | Label Position | Interface Field Description (From logistics website API docs) | Content Example | Business Data/Logistics Company (Distinguishes between our business data and logistics provider data) |
---|---|---|---|---|
shipper.contact.personName | 1 | Sender person | sender person | Business Data |
shipper.contact.phoneNumber | 2 | Sender phone | 1548788481 | Business Data |
shipper.address.streetLine1 | 3 | Sender street address 1 | sender street | Business Data |
shipper.address.city | 4 | Sender city | Fontana | Business Data |
shipper.address.stateOrProvinceCode | 5 | Sender state | CA | Business Data |
shipper.address.zipCode | 6 | Sender zip code | 92337 | Business Data |
recipient.contact.phoneNumber | 7 | Recipient phone | 1347448319 | Business Data |
recipient.contact.personName | 8 | Recipient person | receipt person | Business Data |
recipient.address.streetLine3 | 9 | Recipient street address 3 | receipt street 3 | Business Data |
recipient.address.streetLine2 | 10 | Recipient street address 2 | receipt street 2 | Business Data |
recipient.address.streetLine1 | 11 | Recipient street address 1 | receipt street 1 | Business Data |
recipient.address.city | 12 | Recipient city | CHARLOTTE | Business Data |
recipient.address.stateOrProvinceCode | 13 | Recipient state | NC | Business Data |
recipient.address.zipCode | 14 | Recipient zip code | 282136963 | Business Data |
itemLines.weight | 15 | Package weight | 12 (LB) | Business Data |
itemLines.dimensions.length | 16 | Long (longest) | 108 (IN) | Business Data |
itemLines.dimensions.width | 17 | Width (second length) | 15 (IN) | Business Data |
itemLines.dimensions.height | 18 | High (shortest) | 10 (IN) | Business Data |
itemLines.customerReference.ref1 | 19 | Reference number 1 | item ref1 | Business Data |
itemLines.customerReference.ref2 | 20 | Reference number 2 | item ref2 | Business Data |
no yet | 21 | Sender concern name | Attention Name | Business Data |
no yet | 22 | Recipient concern name | Attention Name | Business Data |
The following is the specific label style.
DPD_DE
ServiceType: CL(DPD CLASSIC)
Logistics Center Interface Fields | Label Position | Interface Field Description (From logistics website API docs) | Content Example | Business Data/Logistics Company (Distinguishes between our business data and logistics provider data) |
---|---|---|---|---|
recipient.contact.personName | 1 | Recipient name 1 | recipient name | Business Data |
recipient.contact.companyName | 2 | Recipient name 2 | recipient company | Business Data |
recipient.address.streetLine1 | 4 | Recipient street | recipient street | Business Data |
recipient.contact.phoneNumber | 5 | Recipient phone | +493641602622 | Business Data |
recipient.address.countryCode | 6 | Recipient country | DE | Business Data |
recipient.address.zipCode | 7 | Recipient zip code | 47877 | Business Data |
recipient.address.city | 8 | Recipient city | shipper city | Business Data |
shipper.contact.personName | 9 | Sender name 1 | shipper name | Business Data |
shipper.contact.companyName | 10 | Sender name 2 | shipper company | Business Data |
shipper.address.streetLine1 | 11 | Sender street | shipper street | Business Data |
shipper.address.countryCode | 12 | Sender country | DE | Business Data |
shipper.address.zipCode | 13 | Sender zip code | 47877 | Business Data |
shipper.address.city | 14 | Sender city | shipper city | Business Data |
shipper.contact.phoneNumber | 15 | Sender phone | +493641602622 | Business Data |
itemLines.weight | 16 | Package weight | 12 (kg) | Business Data |
itemLines.customerReference.ref1 | 17 | Reference number 1 | item ref1 | Business Data |
itemLines.customerReference.ref2 | 18 | Reference number 2 | item ref2 | Business Data |
serviceType | 19 | Logistics service code | After business data is provided, logistics company transcribes it | |
recipient.address.streetLine2 | 20 | Recipient street additional information | Business Data | |
recipient.address.houseNumber | 21 | Recipient street number (house number) (the interface field is limited to a maximum of 8 bits) | Business Data |
The following is the specific label style.
DPD_UK
ServiceType: 1^19(By Road)
Logistics Center Interface Fields | Label Position | Interface Field Description (From logistics website API docs) | Content Example | Business Data/Logistics Company (Distinguishes between our business data and logistics provider data) |
---|---|---|---|---|
recipient.contact.companyName | 1 | Recipient organization | sender Organisation | Business Data |
recipient.address.streetLine1 | 2 | Recipient street | sender street | Business Data |
recipient.address.streetLine2 | 3 | Recipient Locality | sender Locality | Business Data |
recipient.address.city | 4 | Recipient town | sender town | Business Data |
recipient.address.zipCode | 5 | Recipient zip code | 32800 | Business Data |
recipient.address.countryCode | 6 | Recipient country | GB | Business Data |
recipient.contact.personName | 7 | Recipient person | receipt person | Business Data |
recipient.contact.phoneNumber | 8 | Recipient phone | +493641602622 | Business Data |
9 | Logistics Company | |||
itemLines.customerReference.ref1 | 10 | Reference number 1 | reference1 | Business Data |
itemLines.customerReference.ref2 | 11 | Reference number 2 | reference2 | Business Data |
itemLines.customerReference.ref3 | 12 | Reference number 3 | reference3 | Business Data |
shipper.contact.companyName | 13 | Sender organization | sender Organisation | Business Data |
shipper.address.streetLine1 | 14 | Sender street | sender street | Business Data |
shipper.address.streetLine2 | 15 | Sender Locality | sender Locality | Business Data |
shipper.address.city | 16 | Sender town | sender town | Business Data |
shipper.address.zipCode | 17 | Sender zip code | B66 1BY | Business Data |
shipper.contact.phoneNumber | 18 | Sender phone | 0121 123 4567 | Business Data |
itemLines.weight | 19 | Package weight | 20 (kg) | Business Data |
serviceType | 20 | Logistics service code | After business data is provided, logistics company transcribes it. | |
no yet | 21 | Recipient region | ||
recipient.address.instructions | 22 | Delivery instructions | Business Data |
The following is the specific label style.
GLS
ServiceType: GLS_STANDARD(GLS_STANDARD)
Logistics Center Interface Fields | Label Position | Interface Field Description (From logistics website API docs) | Content Example | Business Data/Logistics Company (Distinguishes between our business data and logistics provider data) |
---|---|---|---|---|
shipper.contact.personName | 1 | Name of the shipper | ShipperName1 | Business Data |
shipper.contact.companyName | 2 | Additional consignee name information | ShipperName2 | Business Data |
shipper.address.instructions | 3 | Additional consignee name information | ShipperName3 | Business Data |
shipper.address.streetLine1 | 4 | Street name | ShipperStreet | Business Data |
shipper.address.streetLine2 | 5 | Street number (if not part of the street) | ShipperStreetNumber | Business Data |
shipper.address.countryCode | 6 | Destination country of the shipment | DE | Business Data |
shipper.address.zipCode | 7 | Zip code of the shipper's city | 65760 | Business Data |
shipper.address.city | 8 | City of the shipper | ShipperCity | Business Data |
recipient.contact.personName | 9 | Name of the consignee | Name1 | Business Data |
recipient.contact.companyName | 10 | Additional consignee name information | Name2 | Business Data |
recipient.address.instructions | 11 | Additional consignee name information | Name3 | Business Data |
recipient.address.streetLine1 | 12 | Destination street name | Street | Business Data |
recipient.address.streetLine2 | 13 | Destination street number (if not part of the street) | StreetNumber | Business Data |
recipient.address.countryCode | 14 | Destination country of the shipment | DE | Business Data |
recipient.address.zipCode | 15 | Zip code of the consignee's city | 65760 | Business Data |
recipient.address.city | 16 | City of the consignee | RecipientCity | Business Data |
no yet | 17 | Identifier for the recipient of the parcels | ConsigneeID | |
recipient.contact.personName | 18 | Contact person to print on the label | ConsigneeContactPerson | Business Data |
itemLines[0].customerReference.ref1 | 19 | Notes added to the parcel (line 1) | Note1 | Business Data |
itemLines[0].customerReference.ref2 | 20 | Notes added to the parcel (line 2) | Note2 | Business Data |
itemLines[0].itemTransactionId | 21 | Reference to be given to the parcel | ShipmentUnitReference | Business Data |
itemLines[0].customerReference.ref3 | 22 | Reference for this consignment of parcels | ShipmentReference | Business Data |
recipient.address.zipCode | 23 | Zip code of the consignee's city | 65760 | Business Data |
recipient.address.countryCode | 24 | Destination country of the shipment | DE | Business Data |
itemLines[0].weight | 26 | Each minimum weight is specified by shipper | 18.60 kg | Business Data |
The following is the specific label style.
ServiceType: GLS_SHOP_RETURN(GLS_SHOP_RETURN)
If the shopreturn service is purchased, the consignee and sender data sections will be switched automatically on the return label. This means that the ship-to address provided in the request will be used as the pickup address on the return label.
Logistics Center Interface Fields | Label Position | Interface Field Description (From logistics website API docs) | Content Example | Business Data/Logistics Company (Distinguishes between our business data and logistics provider data) |
---|---|---|---|---|
recipient.contact.personName | 1 | Name of the consignee | Name1 | Business Data |
recipient.contact.companyName | 2 | Additional consignee name information | Name2 | Business Data |
recipient.address.instructions | 3 | Additional consignee name information | Name3 | Business Data |
recipient.address.streetLine1 | 4 | Destination Street name | Street | Business Data |
recipient.address.streetLine2 | 5 | Destination Street number (if not part of the street) | StreetNumber | Business Data |
recipient.address.countryCode | 6 | Destination country of the shipment | DE | Business Data |
recipient.address.zipCode | 7 | Zip code of the consignee's city | 65760 | Business Data |
recipient.address.city | 8 | City of the consignee | RecipientCity | Business Data |
shipper.contact.personName | 9 | Name of the shipper | ShipperName1 | Business Data |
shipper.contact.companyName | 10 | Additional consignee name information | ShipperName2 | Business Data |
shipper.address.instructions | 11 | Additional consignee name information | ShipperName3 | Business Data |
shipper.address.streetLine1 | 12 | Street name | ShipperStreet | Business Data |
shipper.address.streetLine2 | 13 | Street number (if not part of the street) | ShipperStreetNumber | Business Data |
shipper.address.countryCode | 14 | Destination country of the shipment | DE | Business Data |
shipper.address.zipCode | 15 | Zip code of the shipper's city | 65760 | Business Data |
shipper.address.city | 16 | City of the shipper | ShipperCity | Business Data |
no yet | 17 | Identifier for the recipient of the parcels | ConsigneeID | |
itemLines[0].customerReference.ref1 | 18 | Notes added to the parcel (line 1) | Note1 | Business Data |
itemLines[0].customerReference.ref2 | 19 | Notes added to the parcel (line 2) | Note2 | Business Data |
itemLines[0].itemTransactionId | 20 | Reference to be given to the parcel | ShipmentUnitReference | Business Data |
no yet | 21 | Reference for this consignment of parcels | ShipmentReference |
The following is the specific label style.
GEL
ServiceType: 2(EXPRESS 48)
Logistics Center Interface Fields | Label Position | Interface Field Description (From logistics website API docs) | Content Example | Business Data/Logistics Company (Distinguishes between our business data and logistics provider data) |
---|---|---|---|---|
shipper.contact.personName | 1 | Sender name 1 | shipper person | Business Data |
shipper.contact.companyName | 2 | Sender name 2 | shipper company | Business Data |
shipper.address.streetLine1 | 3 | Sender street | shipper street | Business Data |
shipper.address.countryCode | 4 | Sender country | DE | Business Data |
shipper.address.zipCode | 5 | Sender zip code | 47877 | Business Data |
shipper.address.city | 6 | Sender city | shipper city | Business Data |
7 | Shipping date | Logistics Company | ||
itemLines.customerReference.ref1 | 8 | SenderReference number | shipper ref1 | Business Data |
itemLines.customerReference.ref2 | 9 | Special notification requirements for deliveries at delivery stations | shipper ref2 | Business Data |
recipient.contact.personName | 10 | Recipient name 1 | recipient person | Business Data |
recipient.contact.companyName | 11 | Recipient name 2 | recipient company | Business Data |
recipient.address.streetLine1 | 12 | Recipient street | recipient street | Business Data |
recipient.address.countryCode | 13 | Recipient country | DE | Business Data |
recipient.address.zipCode | 14 | Recipient zip code | 47877 | Business Data |
recipient.address.city | 15 | Recipient city | recipient city | Business Data |
itemLines.dimensions.length | 16 | Parcel length | 10 (cm) | Business Data |
itemLines.dimensions.width | 17 | Parcel width | 8 (cm) | Business Data |
itemLines.dimensions.height | 18 | Parcel height | 6 (cm) | Business Data |
itemLines.weight | 19 | Parcel weight | 12 (kg) | Business Data |
serviceType | 20 | Logistics services | 2 | Business Data |
The following is the specific label style.
WHISTL
ServiceType: 661(XPECT48_PODXL)
Logistics Center Interface Fields | Label Position | Interface Field Description (From logistics website API docs) | Content Example | Business Data/Logistics Company (Distinguishes between our business data and logistics provider data) |
---|---|---|---|---|
serviceType | 1 | Logistics services | 661 | Business Data |
2 | Sender information(defaults account level collection address) | Logistics Company | ||
recipient.contact.personName | 3 | Recipient contact name | Alan Lawson | Business Data |
recipient.contact.companyName | 4 | Recipient company name (if empty, take the contact name, this is WHISTL logic) | companyName | Business Data |
recipient.contact.streetLine1 | 5 | Recipient street 1 | hillside barn,56a station road | Business Data |
recipient.address.streetLine2 | 6 | Recipient street 2 | Drive | Business Data |
recipient.address.city | 7 | Recipient city | ridgmont | Business Data |
recipient.address.stateOrProvinceCode | 8 | Recipient area | Area | Business Data |
recipient.address.zipCode | 9 | Recipient zip code | MK43 0UH | Business Data |
recipient.address.countryCode | 10 | Recipient country | GB | Business Data |
itemLines.customerReference.ref1 | 11 | Reference information 1 | RB1-UB-20220221 | Business Data |
itemLines.customerReference.ref2 | 12 | Reference information 2 | 202202021-01 | Business Data |
serviceType | 13 | Logistics service type | After business data is provided, logistics company transcribes it. |
The following is the specific label style.
EVRI
ServiceType: EVRI_STANDARD(EVRI_STANDARD)
Logistics Center Interface Fields | Label Position | Interface Field Description (From logistics website API docs) | Content Example | Business Data/Logistics Company (Distinguishes between our business data and logistics provider data) |
---|---|---|---|---|
recipient.contact.personName | 1 | Recipient name | mihaita victor isac | Business Data |
recipient.address.streetLine1 | 2 | Recipient address 1 | viale edoardo jenner 50 | Business Data |
recipient.address.streetLine2 | 3 | Recipient address 2 | citofono: Leone | Business Data |
recipient.address.city | 4 | Recipient address 3 | milano | Business Data |
itemLines[0].itemCode | 5 | Recipient address 4 | WF284999AAA | Business Data |
recipient.address.zipCode | 6 | Recipient zip code | LE67 1SY | Business Data |
itemLines[0].weight | 7 | Package weight | 15 kg | Business Data |
itemLines[0].customerReference.ref1 | 8 | Reference Information | 171-3339192-1729961 | Business Data |
The following is the specific label style.
AMAZON
ServiceType: Amazon Shipping Ground
Amazon labels come in two formats: AMZL and USPS.
AMZL
Logistics Center Interface Fields | Position | Interface Field Description | Content Example | Business Data/Logistics Company |
---|---|---|---|---|
recipient.contact.companyName | 1 | The name of the business or institution associated with the address. | Company Name | Business Data |
recipient.contact.personName | 2 | The name of the person, business or institution at the address. | My Test Parcel | Business Data |
recipient.address.streetLine1 | 3 | The first line of the address. | 440 Terry Avenue North | Business Data |
recipient.address.streetLine2 | 4 | Additional address information, if required. | Building1 | Business Data |
recipient.address.streetLine3 | 5 | Additional address information, if required. | Suite 200 | Business Data |
recipient.address.city | 6 | The city or town where the person, business or institution is located. | Seattle | Business Data |
recipient.address.stateOrProvinceCode | 7 | The state, county or region where the person, business or institution is located. | WA | Business Data |
recipient.address.countryCode | 8 | The two digit country code. | US | Business Data |
recipient.address.zipCode | 9 | The postal code of that address. | 98109 | Business Data |
itemLines.weight | 10 | The weight in the units indicated. | 1(LB) | Business Data |
The following is the specific label style.
USPS
Logistics Center Interface Fields | Position | Interface Field Description | Content Example | Business Data/Logistics Company |
---|---|---|---|---|
shipper.contact.personName | 1 | The name of the business or institution associated with the address. | GRAND | Business Data |
shipper.address | 2 | Refer to AMZL | SHIPPER ADDRESS | Business Data |
recipient.contact.personName | 3 | The first line of the address. | MASON | Business Data |
recipient.address | 4 | Refer to AMZL | 1103 ZEMAN RD NESKOWIN OR 97149-9770 | Business Data |
The following is the specific label style.