TMF700 Shipping Order API User Guide v4.0.0

This document is the specification of the REST API for Shipping Order Management. Shipping Order is part of the Shipping set of APIs, beside the Shipment Management (TMF 711 in development), Shipment Qualification (TMF 712 in development), and Shipment Tracking (TMF 684).  It includes the model definition as well as all available operations. Possible actions are creating, updating and retrieving Shipping Orders. 

The Shipping Ordering API provides a standardized mechanism for placing a shipping order with all of the necessary order parameters. The API consists of a simple set of operations that interact with logistic systems in a consistent manner. A shipping order is created based on a product order that is managed via Product Order Management. The shipping order captures all the details required to ship a product or a set of products that have been purchased via the product order to the customer. It includes beside the details related to the products identified by the product offers, the actors involved in the process (sender, recipient), locations (from, to), shipping details, instructions and characteristics at the shipping order level or fine grained at every item from the shipping order.

The shipping order references the product order (product order items, product order item offer) and identifies any specific requests made by the customer in regards to the shipping.

A Shipping Order is a document used by a business to specify what items are to be transferred by a logistics partner from a storage location or warehouse to a party location. When goods are sent to the customers, shipment information can be provided to them so they can be aware of when things were shipped and when they will arrive. The service provider creates a Shipping Order which can be sent to a Logistic Partner to manage the physical shipment. The Shipping Order can be split into one or more Shipments with associated Shipment Tracking to capture information about the current status of the shipment, the past checkpoints and the estimated arrival date.

Shipping Order API manages shipping order resource:

• A Shipping Order is a document used by a business to specify what items are to be transferred by a logistics partner from a storage location or warehouse to a party location. When goods are sent to the customers, shipment information can be provided to them so they can be aware of when things were shipped and when they will arrive.
• The service provider creates a Shipping Order which can be sent to a Logistic Partner to manage the physical shipment(s). The Shipping Order can be split into one or more Shipments (Shipment Management (TMF711)) with associated Shipment Tracking (via TMF 684) to capture information about the current status of the shipment, the past checkpoints and the estimated arrival date.
• Main Shipping Order attributes are its identifier, state, items, shipping instructions, related parties involved (recipient, sender), source and destination place.
• Main Shipping Order Items (aka shipping order lines) attributes are the ordered items and product characteristics with the related action to be performed (e.g. add or delete the products), state, location information for delivery.