...
Revisions
Version | Date | Description |
|---|---|---|
| 1.0 | 28-04-2020 | Update yaml versions |
| 0.6 | 12-03-2020 | Add volume limits and error messages; Correct typo in process flow diagrams |
| 0.5 | 13-01-2020 | Add flows and sequence diagrams |
| 0.3 | 11-11-2019 | Add operations |
| 0.1 | 30-08-2019 | Initial document |
...
| The entire set for the standard data exchange with CB consists of the following documents and files: | |
| The mapping from file based to webservice based messages | |
| The functional description of the definitions in the operations | |
| yaml definition files | An OpenAPI Specification file (yaml) for each resource |
MediaOrderB2C v0v1.90.100.yaml | |
| OrderBeheer v1.0.0.yaml | |
Overview webservices
This chapter gives an overview of the available interaction patterns for data exchange with CB. The figure below gives an high level overview of the CB system landscape and the available webservice operations.
CB provides REST based webservices. In REST operations define the available activities.
...
The customer orders multiple products and stock is available for at least one product. Also at least one product is in backlog. The order is shipped in multiple shipments.
Flow description:
- The customer puts multiple products in the shopping basket
- The shop forwards the order to CB with the operation placeOrder
- CB verifies and accepts the order, the shop is notified with the operation notifyOrder and status event In Progress
- CB assigns stock and start order processing for orderline 1. The shop is notified with the operation notifyOrder and status event ProductionReady
- The shop can retrieve the order process status to see which orderline(s) are ready for production and cannot be cancelled anymore
- CB executes pick and pack for orderline 1 and creates a shipment. The shop is notified with the operation notifyShipment and status event Processed
- The shop retrieves the shipment details (including tracking number and a list of products) per shipping unit and can inform the customer
- CB received stock for orderline 2, assigns stock and start order processing for orderline 2. The shop is notified with the operation notifyOrder and status event ProductionReady
- The shop can retrieve the order process status to see which orderline(s) are ready for production and cannot be cancelled anymore
- CB executes pick and pack for orderline 2 and creates a shipment. The shop is notified with the operation notifyShipment and status event Processed
- The shop retrieves the shipment details (including tracking number and a list of products) per shipping unit and can inform the customer
- CB informs the shop that the order is completed with the operation notifyOrder and status event Processed.
Alternative Flow 3 – customer cancellation
The customer orders one or more products, but decides to cancel the order shortly after ordering.
Flow description:
- The customer puts one or more products in the shopping basket
- The shop forwards the order to CB with the operation placeOrder. The operation confirms acceptance of the order
- CB verifies the order, the shop is notified with the operation notifyOrder and status event In Progress
- The customer decides to cancel the order at the shop
- The shop forwards the cancel request per orderline to CB with the operation cancelOrderLine.The operation confirms a successful cancellation
- The shop confirms the cancellation to the customer
- CB informs the shop that the complete order is cancelled with the operation notifyOrder and status event Cancelled