Changelog

2024-11-09

Delivery error comments

The delivery_errors field now also has a comment property, which holds an optional (nullable) internal comment made by an administrator. The goal of this field is to provide additional context of the error for users reading it.

Order comments

The commentsfield has been introduced to the Order model. These are freetext fields to further clarify issues regarding each order, placed by administrators.

2024-10-10

Detailed statuses

The DetailedStatus model has been introduced, displaying detailed tracking information of orders by a parcel-tracking aggregator, which collects data directly from the last-mile courier companies.

2024-08-05

Delivery errors

The delivery_errors field has been introduced to the Order model, which is an array of (freetext) status and date pairs. A delivery error is added whenever an exception happens to an Order.

2024-05-10

Test order placement - Order placement

The test has been added to the Order creation request. If this field is present and has a truthy value (e.g. 1 or “1”) the Order will be marked as not to be forwarded to logistics partners, thus stopping it from being processed. When the test function is not needed, please omit this field from the request to make sure you will not send a value that translates to a truthy value.

Optional original order ID - Order resource

The original_order_id has been made optional even for order types other than REGULAR. From this point this field can be omitted from the Order placement request.

Serial number field - Order resource

The serial_number field has been introduced to the Order resource. For now this field is only a read-only field from the APIs perspective, further updates will be made later if necessary.

Product credentials requirement - Product resource / Order placement

The requires_credentials field has been introduced to the Product resource, which tells if the login/password credentials are needed for an Order placement.

2024-03-07

Update to Order types

From this point, placing an Order with the EXCHANGE order type will automatically create another Order with the RETURN order type, using the same order data.

Danger

Please make sure your setup will not try to create a RETURN order after placing an EXCHANGE order to avoid having multiple return orders for the same order.

2024-02-28

Final completion date

The final_completion_date field of the Order model has been updated, now only shows a value if the order has actually been delivered to the customer.
Prior to this the order was considered delivered even when it reached a pick-up point. From this point an order reaching a pick-up point is only considerd delivered when the user picks up the package.

Opening hours

The opening_hours field has been introduced to the Order model. It is a nullable field that represents the opening hours of the consignee to help the delivery process.

Product and Product Variation

The Product and Product Variation models have been introduced to the API. From this point a Product ID is required for every order creation, and conditionally a Product Variation ID as well (if the Product is a variational product).
The GET /product endpoint have been introduced to help with listing all the available products in the system.

Danger

Please note that this is breaking change, your API calls need to be modified to work properly from this point, as the product_id is a required field in the order placement.