diff --git a/src/api-reference/04.data-types.md b/src/api-reference/04.data-types.md index 8c73f809..c6658b82 100644 --- a/src/api-reference/04.data-types.md +++ b/src/api-reference/04.data-types.md @@ -25,8 +25,14 @@ Platform name Carrier id +**Note:** Some carrier IDs are deprecated and should not be used for new shipments: +- Carrier 5 (Instabox) - DEPRECATED +- Carrier 6 (DHLCheapCargo) - DEPRECATED +- Carrier 7 (BOL) - DEPRECATED +- Carrier 8 (UPS) - DEPRECATED (replaced by carriers 12 and 13) + ## coordinates @@ -100,14 +108,22 @@ Numeric value with decimal fractions. -## isic_code +## hs_code -International Standard Industry Classification. This is mandatory for the -customs form when shipping outside EU. Codes can be found on -the [Douane](https://tarief.douane.nl/arctictariff-public-web/#!/taric/nomenclature/sbn?d=I&cc=&l=nl&ql=nl&ea=false) +Harmonized System code. HS codes classify goods for customs and consist of 6 to 10 digits. +Countries add their own endings for use in export and import customs clearance. +This is mandatory for the customs form when shipping outside EU. Codes can be found on +the [Douane](https://tarief.douane.nl/ite-tariff-public/#/taric/nomenclature/sbn?sd=2026-01-21&d=I&l=nl&ql=nl) website. +Per carrier the supported lengths vary: +DPD: 8 +DHL: 8 or 10 +Bpost: 6 or 8 +Other: 6, 8, or 10 + +To the US, 10 character HS codes are required. - + ## label_position @@ -151,7 +167,9 @@ The different shipments you can create. For SendMyParcel only (package) and (mailbox package) are allowed. For MyParcel it is possible to create international mailbox packages if you have a PostNL contract that allows you to use that product. If you don't have such a contract, you can't create international mailbox package shipments. - +Note: (envelope) is currently only used by shipments. + + ## paper_size diff --git a/src/api-reference/06.shipments.md b/src/api-reference/06.shipments.md index 2fc8c629..bb74d6ae 100644 --- a/src/api-reference/06.shipments.md +++ b/src/api-reference/06.shipments.md @@ -31,8 +31,7 @@ used when creating shipments. #### 2. Mailbox package -This package type is available on -and for PostNL NL shipments that fit into a +This package type is available on for PostNL NL shipments that fit into a mailbox. It supports the `priority_delivery` shipment option. This option is only available for .\ On this package type is available for bpost BE shipments that fit into a mailbox. It does not support additional options.\ @@ -82,15 +81,15 @@ For international shipments, two shipments options are available: tracked and in ### 6.A.2 Delivery types -There are five different delivery types and these specify how the package is +There are eight different delivery types and these specify how the package is delivered. The value is sent with the ShipmentOptions.delivery_type field. Currently, delivery types are only available for NL and BE shipments -with . Delivery types 1-5 for NL and 1,4 +with . Delivery types 1-8 for NL and 1,4 for BE. The address of the package determines the delivery types available. You need to use the DeliveryOptions interface to fetch the delivery types for a specific address. It is also possible to specify a date on which the package has to be delivered with the ShipmentOptions.delivery_date field. With delivery -types 1 & 3 ShipmentOptions.delivery_date is required. +types 1, 3, and 8 ShipmentOptions.delivery_date is required. #### 1. Morning @@ -105,7 +104,7 @@ This is the standard delivery type. #### 3. Evening This option is only available on -and for certain NL addresses. It allows a +for certain NL addresses. It allows a Customer/Consumer to have their package delivered in the evening on the specified delivery date. @@ -116,9 +115,21 @@ Consumer/Customer. #### 5. Pickup express -The same as pickup but the package is available for pickup before 8:30AM on the +The same as pickup, but the package is available for pickup before 8:30AM on the delivery date specified at the drop-off location. Only available on MyParcel.nl. +#### 6. Same Day + +Same day delivery option. The package will be delivered on the same day it is shipped. + +#### 7. Express + +Express delivery option for faster delivery service. + +#### 8. Early Morning + +Early morning delivery option. The package will be delivered in the early morning hours (before standard morning delivery). + ### 6.A.3 Options These are the different package options such as insurance, recipient only, @@ -178,8 +189,8 @@ inside The Netherlands (excluding Wadden Islands). #### age_check -Only available on -and . The Customer/Consumer must sign for the +Only available on . +The Customer/Consumer must sign for the package and only receive it when he is at least 18 years. #### priority_delivery @@ -223,6 +234,30 @@ available for The shipment contains frozen items and requires special handling such as cooled transport, same-day delivery and/or a maximum amount of time outside the freezer. Only available for +#### hide_sender + +Hide the sender information on the label. Only available for and for shipments to Netherlands and Belgium. + +#### same_day_delivery + +Same day delivery service. The package will be delivered on the same day it is shipped. Only available for for domestic NL shipments. Also known as "DHL Today" with delivery between 16:30 and 21:30. + +#### printerless_return + +Printerless return service allows returns without a printed label. Only available for return shipments with (domestic NL) and (NL and BE). Cannot be combined with most other shipment options and requires specific account settings. + +#### collect + +Collect service option for scheduled package collection. Only available for . + +#### drop_off_at_postal_point + +Drop off the package at a postal point instead of regular collection. + +#### extra_assurance + +Additional assurance option for extra peace of mind. Only available for . + ### 6.A.4 Examples ::: expand Pickup @@ -3464,7 +3499,7 @@ HTTP/1.1 204 No Content [eori_number]: /api-reference/04.data-types.html#eori-number [float]: /api-reference/04.data-types.html#float [integer]: /api-reference/04.data-types.html#integer -[isic_code]: /api-reference/04.data-types.html#isic-code +[hs_code]: /api-reference/04.data-types.html#hs-code [label_position]: /api-reference/04.data-types.html#label-position [main]: /api-reference/04.data-types.html#main [month_digit]: /api-reference/04.data-types.html#month-digit diff --git a/src/api-reference/07.shipment-related-object-definitions.md b/src/api-reference/07.shipment-related-object-definitions.md index b26eff20..3cfc3858 100644 --- a/src/api-reference/07.shipment-related-object-definitions.md +++ b/src/api-reference/07.shipment-related-object-definitions.md @@ -746,7 +746,7 @@ Deliver the package to the recipient only. **package_type** Data type: [package_type] Required: yes -The package type. For international shipment only (package) is allowed. +The package type. For international shipments, the available package types depend on the carrier and your contract. (package) is generally supported. International (mailbox package) is available for PostNL with certain contracts. **priority_delivery** Data type: [boolean] @@ -1048,9 +1048,9 @@ Required: Yes. Item value **classification** -Data type: [isic_code] +Data type: [hs_code] Required: Yes. -The International Standard Industry Classification code for this item. +The Harmonized System (HS) code for this item. HS codes classify goods for customs and consist of 6 to 10 digits. **country** Data type: [country_code] @@ -1939,7 +1939,7 @@ nullable: true [eori_number]: /api-reference/04.data-types.html#eori-number [float]: /api-reference/04.data-types.html#float [integer]: /api-reference/04.data-types.html#integer -[isic_code]: /api-reference/04.data-types.html#isic-code +[hs_code]: /api-reference/04.data-types.html#hs-code [label_position]: /api-reference/04.data-types.html#label-position [main]: /api-reference/04.data-types.html#main [month_digit]: /api-reference/04.data-types.html#month-digit diff --git a/src/api-reference/08.delivery-options.md b/src/api-reference/08.delivery-options.md index 6ace7394..8a89c87d 100644 --- a/src/api-reference/08.delivery-options.md +++ b/src/api-reference/08.delivery-options.md @@ -823,7 +823,7 @@ Accept: application/json;charset=utf-8;version=2.0 [eori_number]: /api-reference/04.data-types.html#eori-number [float]: /api-reference/04.data-types.html#float [integer]: /api-reference/04.data-types.html#integer -[isic_code]: /api-reference/04.data-types.html#isic-code +[hs_code]: /api-reference/04.data-types.html#hs-code [label_position]: /api-reference/04.data-types.html#label-position [main]: /api-reference/04.data-types.html#main [month_digit]: /api-reference/04.data-types.html#month-digit diff --git a/src/api-reference/09.delivery-options-object-definitions.md b/src/api-reference/09.delivery-options-object-definitions.md index 71b35618..ad7ab519 100644 --- a/src/api-reference/09.delivery-options-object-definitions.md +++ b/src/api-reference/09.delivery-options-object-definitions.md @@ -310,7 +310,7 @@ Required: n/a. [eori_number]: /api-reference/04.data-types.html#eori-number [float]: /api-reference/04.data-types.html#float [integer]: /api-reference/04.data-types.html#integer -[isic_code]: /api-reference/04.data-types.html#isic-code +[hs_code]: /api-reference/04.data-types.html#hs-code [label_position]: /api-reference/04.data-types.html#label-position [main]: /api-reference/04.data-types.html#main [month_digit]: /api-reference/04.data-types.html#month-digit diff --git a/src/api-reference/10.webhooks.md b/src/api-reference/10.webhooks.md index 69d3b682..6f30e2f1 100644 --- a/src/api-reference/10.webhooks.md +++ b/src/api-reference/10.webhooks.md @@ -186,7 +186,7 @@ Authorization: bearer BASE64_ENCODED_API_KEY [eori_number]: /api-reference/04.data-types.html#eori-number [float]: /api-reference/04.data-types.html#float [integer]: /api-reference/04.data-types.html#integer -[isic_code]: /api-reference/04.data-types.html#isic-code +[hs_code]: /api-reference/04.data-types.html#hs-code [label_position]: /api-reference/04.data-types.html#label-position [main]: /api-reference/04.data-types.html#main [month_digit]: /api-reference/04.data-types.html#month-digit diff --git a/src/api-reference/11.webhook-object-definitions.md b/src/api-reference/11.webhook-object-definitions.md index 70512174..13df6fde 100644 --- a/src/api-reference/11.webhook-object-definitions.md +++ b/src/api-reference/11.webhook-object-definitions.md @@ -250,7 +250,7 @@ Required: n/a. [eori_number]: /api-reference/04.data-types.html#eori-number [float]: /api-reference/04.data-types.html#float [integer]: /api-reference/04.data-types.html#integer -[isic_code]: /api-reference/04.data-types.html#isic-code +[hs_code]: /api-reference/04.data-types.html#hs-code [label_position]: /api-reference/04.data-types.html#label-position [main]: /api-reference/04.data-types.html#main [month_digit]: /api-reference/04.data-types.html#month-digit diff --git a/src/api-reference/12.drop-off-points.md b/src/api-reference/12.drop-off-points.md index 39239119..85eb1413 100644 --- a/src/api-reference/12.drop-off-points.md +++ b/src/api-reference/12.drop-off-points.md @@ -130,7 +130,7 @@ accept: application/json;charset=utf-8 [eori_number]: /api-reference/04.data-types.html#eori-number [float]: /api-reference/04.data-types.html#float [integer]: /api-reference/04.data-types.html#integer -[isic_code]: /api-reference/04.data-types.html#isic-code +[hs_code]: /api-reference/04.data-types.html#hs-code [label_position]: /api-reference/04.data-types.html#label-position [main]: /api-reference/04.data-types.html#main [month_digit]: /api-reference/04.data-types.html#month-digit diff --git a/src/api-reference/13.orders.md b/src/api-reference/13.orders.md index 629ed328..c8e82d34 100644 --- a/src/api-reference/13.orders.md +++ b/src/api-reference/13.orders.md @@ -747,7 +747,7 @@ Content-Type: application/pdf [eori_number]: /api-reference/04.data-types.html#eori-number [float]: /api-reference/04.data-types.html#float [integer]: /api-reference/04.data-types.html#integer -[isic_code]: /api-reference/04.data-types.html#isic-code +[hs_code]: /api-reference/04.data-types.html#hs-code [label_position]: /api-reference/04.data-types.html#label-position [main]: /api-reference/04.data-types.html#main [month_digit]: /api-reference/04.data-types.html#month-digit diff --git a/src/api-reference/14.order-object-definitions.md b/src/api-reference/14.order-object-definitions.md index e3880472..93ee8e9b 100644 --- a/src/api-reference/14.order-object-definitions.md +++ b/src/api-reference/14.order-object-definitions.md @@ -671,7 +671,7 @@ Reference to the order line in the order shipment. [eori_number]: /api-reference/04.data-types.html#eori-number [float]: /api-reference/04.data-types.html#float [integer]: /api-reference/04.data-types.html#integer -[isic_code]: /api-reference/04.data-types.html#isic-code +[hs_code]: /api-reference/04.data-types.html#hs-code [label_position]: /api-reference/04.data-types.html#label-position [main]: /api-reference/04.data-types.html#main [month_digit]: /api-reference/04.data-types.html#month-digit diff --git a/src/documentation/50.php-sdk.md b/src/documentation/50.php-sdk.md index 943860b7..f6efeed5 100644 --- a/src/documentation/50.php-sdk.md +++ b/src/documentation/50.php-sdk.md @@ -1025,8 +1025,8 @@ is mandatory for non-EU shipments. ```php ->setAmount(3) // Amount of items in the package - // ISIC/IDEP code (https://www.cbs.nl/nl-nl/deelnemers-enquetes/deelnemers-enquetes/bedrijven/onderzoek/lopend/internationale-handel-in-goederen/idep-codelijsten) - ->setClassification(0111) // Example: 0111 = "Growing of cereals (except rice), leguminous crops and oil seeds" + // HS code (Harmonized System code): https://tarief.douane.nl/ite-tariff-public/#/taric/nomenclature/sbn?sd=2026-01-21&d=I&l=nl&ql=nl + ->setClassification('010110') // Example: 010110 = "Horses - pure-bred breeding animals" ->setCountry('NL') // Country of origin ->setDescription('Cereal grains') ->setItemValue(40000) // Price of item in cents