diff --git a/src/api-reference/06.shipments.md b/src/api-reference/06.shipments.md index ebac2b0b..2fc8c629 100644 --- a/src/api-reference/06.shipments.md +++ b/src/api-reference/06.shipments.md @@ -33,9 +33,9 @@ used when creating shipments. This package type is available on and for PostNL NL shipments that fit into a -mailbox. It does not support additional options. +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. +shipments that fit into a mailbox. It does not support additional options.\ This package type is also available on for international shipments that fit into a mailbox. Shipment option tracked is available. @@ -124,8 +124,7 @@ delivery date specified at the drop-off location. Only available on MyParcel.nl. These are the different package options such as insurance, recipient only, signature on receipt, XL format etc. These options are specified in the ShipmentOptions -object. These options are only available -for . +object. #### only_recipient @@ -183,6 +182,12 @@ Only available on and . The Customer/Consumer must sign for the package and only receive it when he is at least 18 years. +#### priority_delivery + +Only available on with and .\ +If set, the shipment will be delivered as a priority mailbox package (24 hours).\ +If unset, the shipment will be delivered as a standard mailbox package (48 hours). + #### saturday_delivery Available on and carrier DPD for b2b shipments. No additional fee is paid diff --git a/src/api-reference/07.shipment-related-object-definitions.md b/src/api-reference/07.shipment-related-object-definitions.md index 67d9beff..b26eff20 100644 --- a/src/api-reference/07.shipment-related-object-definitions.md +++ b/src/api-reference/07.shipment-related-object-definitions.md @@ -693,81 +693,85 @@ Only applicable for recipient address data. Containing the vat number of the rec ### 7.C.1 Overview This object contains the shipment options and is embedded in Shipment.options and ReturnShipment.options. +**age_check** +Data type: [boolean] +Required: No +The recipient must sign for the package and must be at least 18 years old. -**package_type** -Data type: [package_type] -Required: yes -The package type. For international shipment only (package) is allowed. - -**delivery_type** -Data type: [delivery_type] -Required: Yes if delivery_date has been specified. -The delivery name for the package. +**cooled_delivery** +Data type: [boolean] +Required: No +Cooled_delivery is only valid for cc=NL and with shipment_type 1 or 3. -**delivery_date** -Data type: [timestamp] -Required: Yes if delivery name has been specified. -The delivery date time for this shipment. +**delivery_date** +Data type: [timestamp] +Required: Yes +if delivery name has been specified. The delivery date time for this shipment. -**only_recipient** -Data type: [boolean] -Required: No. -Deliver the package to the recipient only. +**delivery_type** +Data type: [delivery_type] +Required: Yes +if delivery_date has been specified. The delivery name for the package. -**signature** -Data type: [boolean] -Required: No. -Package must be signed for. +**fresh_food** +Data type: [boolean] +Required: No +The shipment contains fresh food and requires special handling -**return** -Data type: [boolean] -Required: No. -Return the package if the recipient is not home. +**frozen** +Data type: [boolean] +Required: No +The shipment contains frozen items and requires special handling -**insurance** -Data type: [price] -Required: No. +**insurance** +Data type: [price] +Required: No Insurance price for the package. -**large_format** -Data type: [boolean] -Required: No. +**label_description** +Data type: [string] +Required: No +This description will appear on the shipment label. **Note: This will be overridden for return shipment by the following: Retour – 3SMYPAMYPAXXXXXX** + +**large_format** +Data type: [boolean] +Required: No Large format package. -**cooled_delivery** -Data type: [boolean] -Required: No. -Cooled_delivery is only valid for cc=NL and with shipment_type 1 or 3. +**only_recipient** +Data type: [boolean] +Required: No +Deliver the package to the recipient only. -**label_description** -Data type: [string] -Required: No. -This description will appear on the shipment label. **Note: This will be overridden for return shipment by the following: Retour – 3SMYPAMYPAXXXXXX** +**package_type** +Data type: [package_type] +Required: yes +The package type. For international shipment only (package) is allowed. -**age_check** -Data type: [boolean] -Required: No. -The recipient must sign for the package and must be at least 18 years old. +**priority_delivery** +Data type: [boolean] +Required: No +If selected, the package will be delivered with high(er) priority (24 hour). -**receipt_code** -Data type: [boolean] -Required: No. +**receipt_code** +Data type: [boolean] +Required: No The recipient receives a code via email that must be confirmed upon delivery. Requires insurance and recipient email address. -**saturday_delivery** -Data type: [boolean] -Required: No. -The package will be delivered on a Saturday +**return** +Data type: [boolean] +Required: No +Return the package if the recipient is not home. -**fresh_food** -Data type: [boolean] -Required: No. -The shipment contains fresh food and requires special handling +**saturday_delivery** +Data type: [boolean] +Required: No +The package will be delivered on a Saturday -**frozen** -Data type: [boolean] -Required: No. -The shipment contains frozen items and requires special handling +**signature** +Data type: [boolean] +Required: No +Package must be signed for. ### 7.C.2 Example