Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 26 additions & 8 deletions src/api-reference/04.data-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<DataTypeDefinition
values="1,2,3,4,5,9,10,11,12,13,14,15,16"
values="1,2,3,4,9,10,11,12,13,14,15,16,17,18"
example="
1 (PostNL),
2 (bpost. Only available on sendmyparcel.be),
Expand All @@ -39,7 +45,9 @@ Carrier id
13 (UPS Express Saver. Only available on MyParcel.nl),
14 (GLS. Only available on MyParcel.nl),
15 (BRT),
16 (Trunkrs)
16 (Trunkrs),
17 (InPost),
18 (PosteItaliane)
" />

## coordinates
Expand Down Expand Up @@ -100,14 +108,22 @@ Numeric value with decimal fractions.

<DataTypeDefinition pattern="/\d+\.\d+/" example="1.1248" />

## 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.

<DataTypeDefinition pattern="/\d{1,4}/" example="9609 (Pencils)" />
<DataTypeDefinition pattern="/\d{6,10}/" example="960910 (Pencils, including propelling pencils)" />

## label_position

Expand Down Expand Up @@ -151,7 +167,9 @@ The different shipments you can create. For SendMyParcel
only <DataType type="package-type" id="1" /> (package) and <DataType type="package-type" id="2" /> (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.

<DataTypeDefinition values="1,2,3,4,5,6" example="1. package,2. mailbox package,3. letter,4. digital stamp,5. pallet,6. small package" />
Note: <DataType type="package-type" id="7" /> (envelope) is currently only used by <DataType type="carrier" name="DHL for You" /> shipments.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Jij bent echt een topper


<DataTypeDefinition values="1,2,3,4,5,6,7" example="1. package,2. mailbox package,3. letter,4. digital stamp,5. pallet,6. small package,7. envelope" />

## paper_size

Expand Down
55 changes: 45 additions & 10 deletions src/api-reference/06.shipments.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@ used when creating shipments.

#### 2. Mailbox package

This package type is available on <DataType type="platform" id="1" />
and <DataType type="platform" id="2" /> for PostNL NL shipments that fit into a
This package type is available on <DataType type="platform" id="1" /> for PostNL NL shipments that fit into a
mailbox. It supports the `priority_delivery` shipment option. This option is only available for <DataType type="carrier" name="postnl" />.\
On <DataType type="platform" id="3" /> this package type is available for bpost BE
shipments that fit into a mailbox. It does not support additional options.\
Expand Down Expand Up @@ -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 <DataType type="package-type" id="1" />. Delivery types 1-5 for NL and 1,4
with <DataType type="package-type" id="1" />. 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Voor early morning delivery (toegevoegd voor BRT) is geen delivery date verplicht.


#### 1. Morning

Expand All @@ -105,7 +104,7 @@ This is the standard delivery type.
#### 3. Evening

This option is only available on <DataType type="platform" id="1" />
and <DataType type="platform" id="2" /> 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.

Expand All @@ -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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Early morning delivery option. The package will be delivered in the early morning hours (before standard morning delivery).
Early morning delivery option. The package will be delivered in the early morning hours (before morning delivery).

I would drop the word standard as that refers to another delivery type.


### 6.A.3 Options

These are the different package options such as insurance, recipient only,
Expand Down Expand Up @@ -178,8 +189,8 @@ inside The Netherlands (excluding Wadden Islands).

#### age_check

Only available on <DataType type="platform" id="1" />
and <DataType type="platform" id="2" />. The Customer/Consumer must sign for the
Only available on <DataType type="platform" id="1" />.
The Customer/Consumer must sign for the
package and only receive it when he is at least 18 years.

#### priority_delivery
Expand Down Expand Up @@ -223,6 +234,30 @@ available for <DataType type="carrier" name="trunkrs" />
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 <DataType type="carrier" name="trunkrs"/>

#### hide_sender
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick:
Ik heb vorige keer een stukje georganiseerd op alfabetische volgorde, wellicht leest dat hier ook lekkerder weg.


Hide the sender information on the label. Only available for <DataType type="carrier" name="DHL for You" /> and <DataType type="carrier" name="DHL Europlus" /> 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 <DataType type="carrier" name="DHL for You" /> for domestic NL shipments. Also known as "DHL Today" with delivery between 16:30 and 21:30.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is ook van toepassing voor Trunkrs.


#### printerless_return

Printerless return service allows returns without a printed label. Only available for return shipments with <DataType type="carrier" name="postnl" /> (domestic NL) and <DataType type="carrier" name="DHL for You" /> (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 <DataType type="carrier" name="trunkrs" />.

#### 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 <DataType type="carrier" name="DHL for You" />.

### 6.A.4 Examples

::: expand Pickup
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions src/api-reference/07.shipment-related-object-definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <DataType type="package-type" id="1" /> (package) is allowed.
The package type. For international shipments, the available package types depend on the carrier and your contract. <DataType type="package-type" id="1" /> (package) is generally supported. International <DataType type="package-type" id="2" /> (mailbox package) is available for PostNL with certain contracts.

**priority_delivery**
Data type: [boolean]
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/api-reference/08.delivery-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/api-reference/10.webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/api-reference/11.webhook-object-definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/api-reference/12.drop-off-points.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/api-reference/13.orders.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/api-reference/14.order-object-definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/documentation/50.php-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading