Resources

There is a WADL document available that describes the resources API.

name path methods description
Delivery API
  • /order-management/delivery/deliveries
  • /order-management/delivery/deliveries/{deliveryId}
  • GET
  • PATCH
A delivery is when we go from ordered goods to delivered goods. We pick and pack as much as we can, and send it to the consumer.
Order API
  • /order-management/order/orders
  • GET
An order is a placed / requested purchase from a customer. From the order we create a delivery in which we place the goods purchased on the order.
Return API
  • /order-management/return/returns
  • /order-management/return/returns/{returnId}
  • GET
  • PATCH
A return contains information about goods that is being (or has been) sent back to the warehouse or physical stores.

Data Types

type description
Address Information about a geographical address.
Delivery A delivery.
DeliveryChanges Contains changes that applies to a delivery.
DeliveryCustomer Contains customer information for a delivery.
DeliveryMethod The method being used to deliver the goods to the consumer.
DeliveryMethod The method being used to deliver the goods to the consumer.
DeliveryParcel Holds information about a single parcel.
DeliveryPoint Holds information about the delivery point for the delivery.
DeliveryPointAddress Information about a delivery point address.
DeliveryResult Holds a search result of deliveries.
DeliveryRow A single row of a delivery.
DeliveryRowChanges Contains changes that applies to a delivery row.
DeliveryRowValue Contains values of a delivery row.
DeliveryStatus The status of a delivery.
DeliveryValue Contains values of the delivery.
Order An order.
OrderCustomer Contains customer information for a order.
OrderResult Holds a search result for orders.
OrderRow A single row of a order.
OrderRowValue Contains values of a order row.
OrderStatus The status of a order.
OrderValue Contains values of the order.
PaymentMethod Holds information about the payment method.
Return A return.
ReturnChanges Contains changes that applies to a return.
ReturnReason The reason for a return.
ReturnResult Holds a search result of returns.
ReturnRow A single row of a return.
ReturnRowChanges Contains changes that applies to a return row.
ReturnRowValue Contains values of a return row.
ReturnStatus The status of a return.
ReturnValue The value of a return.
ServiceProvider The Service provider
SubscriptionInformation Contains subscription information for a order.
Warehouse The warehouse of a return.