Shipments

For Shipments we made changes to align with the pre-defined conventions and put effort in aligning the models of Orders and Shipments. Also we made the models more logical and removed unused fields.

GET shipments

Query parameters

No changes

Response message

Table 1. Changed fields in response
Change v3 field name v4 field name Remarks

Renamed

shipmentDate

shipmentDateTime

Introduced

order (object)

Moved

shipmentItems.orderId

order.orderId

Introduced

order.orderPlacedDateTime

Introduced

shipmentItems.ean

GET shipment

Query parameters

No changes

Response message

Table 2. Changed fields in response
Change v3 field name v4 field name Remarks

Introduced

order (object)

Moved

shipmentItems.orderId

order.orderId

Removed

shipmentItems.orderDate

Introduced

order.orderPlacedDateTime

Renamed

shipmentDate

shipmentDateTime

Renamed

customerDetails

shipmentDetails

Removed

customerDetails.salutationCode

Introduced

shipmentDetails.salutation

Renamed

customerDetails.houseNumberExtended

shipmentDetails.houseNumberExtension

Removed

customerDetails.addressSupplement

Changed

customerDetails.zipCode

The ZIP code format has been changed from '1234 AB' to '1234AB' for NL orders and to '0000' format for BE orders.

Removed

customerDetails.vatNumber

Removed

customerDetails.chamerOfCommerceNumber

Removed

customerDetails.orderReference

Removed

billingDetails.pickupPointName

Removed

billingDetails.salutationCode

Introduced

billingDetails.salutation

Renamed

billingDetails.houseNumberExtended

billingDetails.houseNumberExtension

Removed

billingDetails.addressSupplement

Changed

billingDetails.zipCode

The ZIP code format has been changed from '1234 AB' to '1234AB' for NL orders and to '0000' format for BE orders.

Renamed

billingDetails.chamberOfCommerceNumber

billingDetails.kvkNumber

Removed

billingDetails.deliveryPhoneNumber

Introduced

shipmentItems.fulfilment (object)

Removed

shipmentItems.fulfilmentMethod

Introduced

shipmentItems.fulfilment.method

Removed

shipmentItems.latestDeliveryDate

Introduced

shipmentItems.fulfilment.latestDeliveryDate

Field type has been changed to a date instead of datetime in version 3

Introduced

shipmentItems.fulfilment.distributionParty

Introduced

shipmentItems.offer (object)

Removed

transport.shippingLabelCode

Introduced

shipmentItems.offer.offerId

Removed

shipmentItems.offerReference

Introduced

shipmentItems.offer.reference

Removed

shipmentItems.offerCondition

Introduced

shipmentItems.product (object)

Moved

shipmentItems.ean

shipmentItems.product.ean

Moved

shipmentItems.title

shipmentItems.product.title

Moved

customerDetails.pickUpPointName

shipmentDetails.pickUpPointName

Removed

shipmentItems.offerPrice

Introduced

shipmentItems.unitPrice

Do note that this field has a different source and is not the same as the former 'offerPrice' field

Introduced

shipmentItems.commission

Moved

transport.shippingLabelId

shippingLabelId

Back to Returns

Continue to Shipping labels