| ageCheck |
int |
Indicates the minimal age of the recipient to be able to receive a shipment sent with this product/method |
[optional] |
| b2b |
bool |
Indicates whether this product/method can be used for B2B shipments |
[optional] |
| b2c |
bool |
Indicates whether this product/method can be used for B2C shipments (shipments between a business and a person) |
[optional] |
| boxable |
bool |
Indicates whether the shipment fits in a box |
[optional] |
| bulkyGoods |
bool |
Indicates that this method/product is suitable for sending bulky goods |
[optional] |
| carrierBillingType |
string |
Indicates the carrier billing method |
[optional] |
| cashOnDelivery |
int |
Indicates the maximum value of cash-on-delivery payment and that this method/product can be used for COD shipments |
[optional] |
| dangerousGoods |
bool |
Indicates that this product/method can be used to ship dangerous goods (ADR goods) |
[optional] |
| deliveryAttempts |
int |
Indicates the future amount of attempts for home deliveries until the package is rerouted to the sender or a service point |
[optional] |
| deliveryBefore |
string |
Indicates that a shipment sent with this method/product will be delivered before the time specified on the day of delivery. Should be expressed in military time format (HHMM) |
[optional] |
| deliveryDeadline |
string |
Indicates the delivery deadline, that is the guarantee of time to deliver by a carrier. These usually come with some requirements, e.g. same day delivery may only be available if a shipment is acquired by a carrier before noon on the same day. Values: * BEST_EFFORT(best_effort): the shipment will be delivered by a carrier ASAP * SAMEDAY(sameday): the shipment will be delivered by a carrier on the day of acquiring the shipment * NEXTDAY(nextday): the shipment will be delivered by a carrier on the day next to the day of acquiring the shipment * WITHIN_24H(within_24h): the shipment will be delivered by a carrier within 24 hours from acquiring the shipment * WITHIN_48H(within_48h): the shipment will be delivered by a carrier within 48 hours from acquiring the shipment * WITHIN_72H(within_72h): the shipment will be delivered by a carrier within 72 hours from acquiring the shipment |
[optional] |
| directContractOnly |
bool |
Indicates that this method is only available for shipments with a direct (SaaS) contract |
[optional] |
| ecoDelivery |
bool |
Indicates that a shipment with this method will be delivered in an ecologically friendly way |
[optional] |
| firstMile |
string |
Indicates how a shipment should be acquired by a carrier using the chosen method. Values: * PICKUP(pickup): the shipment should be picked up by the carrier's drivers from the sender (one-time) * DROPOFF(dropoff): the shipment should be handed in for delivery at a service point * PICKUP_DROPOFF(pickup_dropoff): the shipment can be either picked up by a carrier's driver, or be handed in for delivery at a service point * FULFILMENT(filfilment): the shipment should be picked up by a recurrent pickup |
[optional] |
| flexDelivery |
bool |
Indicates whether flexible rerouting is available for a shipment sent with this product/method |
[optional] |
| formFactor |
string |
Indicates the form factor of a shipment in general terms Values: * LETTER(letter) * PARCEL(parcel) * MAILBOX(mailbox) * PALLET(pallet) * LONG(long) |
[optional] |
| fragileGoods |
bool |
Indicates that fragile goods may be delivered with this method/product |
[optional] |
| freshGoods |
bool |
Inicates that fresh/perishable goods may be delivered with this method/product |
[optional] |
| harmonizedLabel |
bool |
Indicates whether a harmonized label (a shipping label combined with customs documents) will be created for a shipment using this product/method |
[optional] |
| idCheck |
bool |
Indicates whether a recipient will be asked to show a proof of identity when receiving a package. Related to AgeCheck, but not the same. |
[optional] |
| incoterm |
string |
Indicates the customs terms of shipping, e.g. who is responsible for paying taxes and duties for international shipments. Values: * DDU(ddu) - Delivery Duty Unpaid, recipient pays duties * DDP(ddp) - Delivery Duty Paid, sender pays duties * DAP(dap) - Delivery At Place, the seller is responsible for delivery of the goods, ready for unloading, at the named place of destination. * DAP NP(dap_np) - Delivery At Place (duties & taxes Not Paid), the seller is responsible for delivery of the goods, ready for unloading, at the named place of destination. Seller bears costs of shipping incl. clearance. Receiver bears the costs and risks of duties and VAT. * DAP DP(dap_dp) - Delivery At Place (duties & taxes Paid), the seller is responsible for delivery of the goods, ready for unloading, at the named place of destination. Seller bears the costs and risks of transport, clearance, duties and VAT. |
[optional] |
| insurance |
int |
Indicates the amount of insurance provided by a carrier for a shipment with this method/product |
[optional] |
| lastMile |
string |
Indicates the end destination of a shipment (i.e. where it will be delivered) Formerly known as Destination Type Values: * HOME_DELIVERY (home_delivery) - regular parcel delivery at home * SERVICE_POINT (service_point) - the shipment will be delivered to a service point * MAILBOX (mailbox) - the shipment will be delivered to a mailbox of a recepient (related to FormFactor.MAILBOX) * POBOX (pobox) - the shipment will be delivered to a postal office box or a postamat |
[optional] |
| manually |
bool |
Indicates a subset of Deutsche Post shipping methods where a consumer should manually attach the label to the parcel. |
[optional] |
| multicollo |
bool |
Indicates whether multicollo shipments are possible with this product/method. Multicollo shipments consist of multiple packages which are created and sent at the same moment to the same receiver address. All parcels of a multicollo shipment will be delivered to the recipient at once. |
[optional] |
| neighborDelivery |
bool |
Indicates the neighbour delivery availability. If the recipient is unavailable at the moment of delivery, the shipment sent with this method/product can be delivered to neighbours. |
[optional] |
| nonConveyable |
bool |
Indicates that a shipment sent with this product/method shouldn't be transported by conveyors. |
[optional] |
| personalizedDelivery |
bool |
Indicates a subset of Deutsche Post shipping methods shipping to a consumer. |
[optional] |
| premium |
bool |
Indicates whether the carrier identifies the shipments shipping process as premium. |
[optional] |
| priority |
string |
Indicates the priority of a shipment. Values: * ECONOMICAL(economical): cheap but slow * STANDARD(standard): regular * PRIORITY(priority): prioritzed delivery, might be the same as EXPRESS * EXPRESS(express): Express delivery |
[optional] |
| registeredDelivery |
bool |
Indicates that the delivery of this shipment will be registered. |
[optional] |
| returns |
bool |
Indicates that this product/method can be used for return shipments |
[optional] |
| segment |
string |
Internal functionality we use to support different pricing for PostNL shipments for users of different segments |
[optional] |
| serviceArea |
string |
Indicates the service area of this product/method, for example — where it can be used Values: * DOMESTIC (domestic): available for domestic (national) shipments * DOMESTIC_REMOTE (domestic_remote): available for shipments to domestic remote territories (e.g. overseas) * INTERNATIONAL (international): available for international shipments |
[optional] |
| signature |
bool |
Indicates that a recipient signature will be required on delivery of a shipment sent with this product/method. |
[optional] |
| size |
string |
Indicates the size of a shipment. Note that the concept of a size may vary per carrier and per form factor. Values: * XS(xs) * S(s) * M(m) * L(l) * XL(xl) * XXL(xxl) |
[optional] |
| sorted |
bool |
Indicates whether the shipment(s) are handed over the carrier in a sorted fashion, decreasing costs. |
[optional] |
| surcharge |
bool |
Indicates whether the carrier can surcharge the shipment later, based on (volumetric) weight. |
[optional] |
| tracked |
bool |
Indicates that this shipment can be tracked. |
[optional] |
| tyres |
bool |
Indicates that this shipping method/product can be used to ship tyres |
[optional] |
| weekendDelivery |
string |
Indicates whether deliveries with this method/product are available on the weekends Values: * SATURDAY (saturday) - can be delivered on Saturday * SUNDAY (sunday) - can be delivered on Sunday * WEEKENDS (weekends) - - can be delivered during the weekends' |
[optional] |
| ers |
bool |
Indicates if a shipment with this method can be sent via the Easy Return Solution for e-commerce parcels platform. Many national carriers are part of this platform. |
[optional] |
| pickUp |
bool |
Indicates that this shipping method/product will be picked up by the carrier |
[optional] |
| labelless |
bool |
Indicates that this shipping method/product can be announced with a QR code instead of a traditional label |
[optional] |