Upgrade guide to Order API version 2

Orders

The Orders endpoint in v2 has not changed in functionality. However, there are changes in endpoint URI and existing element names, and new elements have been added. Please check the Order Endpoint page for more information.

Element Change
OpenOrders Renamed to Orders.
OpenOrder Renamed to Order.
OpenOrderItems Renamed to OrderItems.
OpenOrderItem Renamed OrderItem.
Paid Removed.
Buyer Renamed CustomerDetails.
Telephone Renamed DeliveryPhoneNumber
FirstName Renamed to Firstname.
VatNumber Added.
ExtraAddressInformation Added.
ReferenceCode Renamed to OfferReference.
Condition Renamed to OfferCondition.
Price Renamed to OfferPrice.
CancelRequest Added.
DeliveryPeriod Replaced by PromisedDeliveryDate.

Shipments and Cancellations

New endpoints have been created for Shipments and cancellations.

To create a shipment in v2, please use the endpoint below. Check the shipment endpoint page for more information.

POST /services/rest/shipments/v2

To cancel an order in v2, please use the endpoint below. Check the order endpoint page for more information.

PUT /services/rest/order-items/v2/:id/cancellation

Please note that /services/rest/orders/v1/process/ endpoint has been removed and replaced by the endpoint below. Check the process-status endpoint for more information.

/services/rest/process-status/v2/:id

The old shipment endpoint allowed for processing an entire order in 1 API request, regardless of the amount of OrderItems within an order.

The new shipment endpoint only allows for sending 1 orderitem per shipment. This means you will need to create a shipment for every orderitem seperately within an order.

Processing-status

Processing-status endpoint has been renamed to “process-status”. To retrieve a process-status in v2, please use the endpoint below. Check the process-status endpoint for more information.

/services/rest/process-status/v2/:id

Note: Every PUT and POST request in v2 will result in a response with a Process-status Id. Please use this Process-status Id in the query of the process-status endpoint. The process-status endpoint will provide you with a SUCCESS or FAILED message and the reason for this status.

Payments

The payments endpoint has not changed in functionality. However, some elements have been added or changed.

Element Change
DateTimeShipment Renamed to ShipmentDate.
ShippingLabelCosts Added.
ShippingLabelVAT Added.
ShipmentReference Added.
ShipmentShippingLabelCosts Added.
ShipmentShippingLabelVAT Added.
ShipmentShippingLabelVATType Added.
ReferenceCode Renamed to OfferReference.
Price Renamed to OfferPrice.