Orders

For Orders we made changes to align with our predefined conventions and aligned the models of Orders and Shipments. We also made the models more logical and removed unused fields.

GET orders

Query parameters

Table 1. Changed field in query
Change v3 field name v5 field name Remarks

Introduced

status

Functional documentation on the status field can be found here.

Response message

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

Renamed

dateTimeOrderPlaced

orderPlacedDateTime

Removed

cancelRequest

Introduced

orders.orderItems.quantityShipped

Introduced

orders.orderItems.quantityCancelled

GET order

Get order now filters by default on status=ALL. For more information see here.

Query parameters

No changes

Response message

Table 3. Changed fields in response
Change v3 field name v5 field name Remarks

Renamed

dateTimeOrderPlaced

orderPlacedDateTime

Removed

customerDetails

Removed

shipmentDetails.salutationCode

Introduced

shipmentDetails.salutation

Renamed

shipmentDetails.surName

shipmentDetails.surname

Renamed

shipmentDetails.houseNumberExtended

shipmentDetails.houseNumberExtension

Removed

shipmentDetails.addressSupplement

Removed

shipmentDetails.vatNumber

Removed

shipmentDetails.chamberOfCommerceNumber

Removed

shipmentDetails.orderReference

Changed

shipmentDetails.zipCode

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

Removed

billingDetails.pickUpPointName

Removed

billingDetails.salutationCode

Introduced

billingDetails.salutation

Renamed

billingDetails.surName

billingDetails.surname

Renamed

billingDetails.houseNumberExtended

billingDetails.houseNumberExtension

Removed

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

orderItems.fulfilment (object)

Removed

orderItems.fulfilmentMethod

Introduced

orderItems.fulfilment.method

Moved

orderItems.latestDeliveryDate

orderItems.fulfilment.latestDeliveryDate

Moved

orderItems.expiryDate

orderItems.fulfilment.expiryDate

Moved

orderItems.exactDeliveryDate

orderItems.fulfilment.exactDeliveryDate

Introduced

orderItems.fulfilment.distributionParty

Renamed

orderItems.cancelRequest

orderItems.cancellationRequest

Removed

orderItems.offerid

Removed

orderItems.offerReference

Introduced

orderItems.offer (object)

Introduced

orderItems.offer.offerId

Introduced

orderItems.offer.reference

Removed

orderItems.offerPrice

Removed

orderItems.offerCondition

Introduced

orderItems.unitPrice

This field has a different source and is not the same as the former 'offerPrice' field.

Introduced

orderItems.product (object)

Moved

orderItems.ean

orderItems.product.ean

Moved

orderItems.title

orderItems.product.title

Renamed

orderitems.transactionFee

orderItems.commission

Introduced

orderItems.quantityShipped

Introduced

orderItems.quantityCancelled

Introduced

orderItems.totalPrice

Renamed

pickUpPoint

pickupPoint

Renamed

shipmentDetails.pickUpPointName

shipmentDetails.pickupPointName

PUT cancel order item

Path parameter

Table 4. Changes in path parameter
Change v3 field name v5 field name Remarks

Removed

order-item-id

The order item ID has been removed from the path and introduced in the request body.

Request body

Table 5. Changed fields in request body
Change v3 field name v5 field name Remarks

Removed

reasonCode

Introduced

orderItems

Introduced

orderItems.orderItemId

Introduced

orderItems.reasonCode

Response message

Table 6. Changed fields in response
Change v3 field name v5 field name Remarks

Renamed and changed

id

processStatusId

Type changed to string

PUT ship order item

Path parameter

Table 7. Changes in path parameter
Change v3 field name v5 field name Remarks

Removed

order-item-id

The order item ID has been removed from the path and introduced in the request body.

Request body

Table 8. Changed fields in request body
Change v3 field name v4 field name Remarks

Removed

shippingLabelCode

Introduced

shippingLabelId

Introduced

orderItems (object)

Introduced

orderItems.orderItemId

Response message

Table 9. Changed fields in response
Change v3 field name v5 field name Remarks

Renamed and changed

id

processStatusId

Type changed to string

Back to Offers

Continue to Process status