Providing needed data
In order to allow for frictionless carrier operations certain data is needed and it is considered best practice to store / supply these in the entitities used in the process.
Last updated
Was this helpful?
In order to allow for frictionless carrier operations certain data is needed and it is considered best practice to store / supply these in the entitities used in the process.
Last updated
Was this helpful?
In the section about you already learned about the concept of needed data for certain combinations when shipping goods from A to B. Please see the following table in order to find out which data is needed and where to provide it correctly.
Possibility to overwrite given values
fulfillmenttools offers the possibility to overwrite default values for the address used to request a label in the end. By default the facility address is taken when creating the shipment or the parcels. However, you can replace the address where the shipment is originating from if needed without the need of touching the facility address. This adds further flexibility when implementing your own workflows.
In which way overwriting values is supported is being mentioned in the following sections explicitly.
Mandatory
Source Address
facility.address
Recommended
Telephone Number
facility.address.phoneNumbers
Recommended
Email address
facility.address.emailAddresses
Overwriting source Address of shipments
parcel.sender ▷ shipment.sourceAddress ▷ facility.address (default)
(▷ = left overwrites right)
Mandatory
Consumer or Target postal address (preferably with a housenumber)
order.consumer.addresses[addressType = POSTAL_ADDRESS]
Recommended
Consumer telephone number
order.consumer.addresses[addressType = POSTAL_ADDRESS].phoneNumbers[0]
Recommended
Consumer email address
order.consumer.email
Overwriting target address of shipments
Regarding address and phone numbers
parcel.recipient ▷ shipment.targetAddress ▷ order.consumer.addresses[addressType = POSTAL_ADDRESS] (default)
Regarding email address
parcel.recipient ▷ shipment.targetAddress ▷ order.consumer.email (default) ▷ carrier.configuration.fallBackTrackAndTraceEmail (fallback)
(▷ = left overwrites right)
The following data is especially important when sending non-domestic shipments. However, best-practice is to always provide this data / provide it in listings of facilities that are performing international shipments.
Recommended
HS Code (preferably 8 digits)
order.orderLine.article.attributes
Recommended
Customs value per unit The value of the good per unit in the smallest indivisible unit of the currency. For example: Cents for EUR (25 EUR have the value 2500) or piastres for EGP (50 EGP have the value 5000). This value will be used when you request labels for non-domestic shipments. Taking the goods that are inside a parcel into consideration the customs value is calculated. The value of a unit is multiplied with the quantity of items present in the parcel.
order.orderLine.article.attributes
Recommended
order.orderLine.article.attributes
Recommended
order.orderLine.article.attributes
Overwriting customs related data
orderLine.article.attributes ▷ listing.attributes
(▷ = left overwrites right)
fulfillmenttools offers the possibility to supply insurance relevant data to carriers. This is especially important for carriers, that offer this kind of service as the value of the parcels is calculated taking these values into consideration before the label is requested at the carrier.
Recommended
Insurance value per unit The value of the good per unit in the smallest indivisible unit of the currency. For example: Cents for EUR (25 EUR have the value 2500) or piastres for EGP (50 EGP have the value 5000).
order.orderLine.article.attributes
Recommended
order.orderLine.article.attributes
Recommended
order.orderLine.article.attributes
Overwriting insurance related data
orderLine.article.attributes ▷ listing.attributes
(▷ = left overwrites right)
Recommended
Weight of a single item (in grams)
order.orderLine.article.attributes
Optional
Height of a single item (in mm)
order.orderLine.article.attributes
Optional
Width of a single item (in mm)
order.orderLine.article.attributes
Optional
Length of a single item (in mm)
order.orderLine.article.attributes
Overwriting dimensional data
orderLine.article.attributes ▷ listing.attributes
(▷ = left overwrites right)
The Harmonized Commodity Description and Coding System, also known as the Harmonized System (HS) of is an internationally standardized system of names and numbers to classify traded products. (...) -- Source:
Customs currency This value depicts the currency used for providing customs related data in when requesting a parcel label.
Customs number of decimal places This number depicts the number of decimal places used for the currency and value per unit. Note: If not passed, this value will be filled automatically upon item creation according to .
Insurance currency This value presents the currency in .
Insurance number of decimal places This number depicts the number of decimal places used for the currency and value per unit. Note: If not passed, this value will be filled automatically upon item creation according to .