- Home
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}
|
|
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
|
|
An order is a purchase from any kind of source (web, phone, subscription, etc) containing a set of order rows.
|
Return API
|
- /order-management/return/returns
- /order-management/return/returns/{returnId}
|
|
A return contains information about goods that is being (or has been) sent back to the warehouse or physical stores.
|
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.
|
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 of 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.
|
Return
|
A return.
|
ReturnChanges
|
Contains changes that applies to 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.
|
ReturnStatus
|
The status of a return.
|