Pre-shipped products

Overview

This document is for merchants that sell items that are shipped directly once the order is placed. The capability to process orders with pre-shipped items is a solution that allows to offer a wider range of items, as well as complete the order flow for other items within the same order . Main use cases are:

  • Virtual/downloadable products: tickets, virtual music albums…
  • Products bought and picked directly in store

Such pre-shipped lines skip the stock allocation and sourcing logic as is already shown which source provides the item.

The flow in your OMS for the pre-shipped lines still generates a shipment request message and expects a response either indicating if the line has been shipped or cancelled.

How to import an order with pre-shipped lines

In order to create an order with preshipped lines the order.create message needs to indicate:

  • “status”: “PRESHIPPED” for each line that is pre-shipped (this status will ensure that the line will skip the sourcing and stock allocation process)
  • “source_location”: “xxx” for each line thqat is pre-shipped (defines which source will provide the item)
  • the order needs to include at least one shipping method “sku”: “PRESHIPPED”, and this method needs to exist in the catalogue
  • each pre-shipped order line needs to have a reference to the shipping line “PRESHIPPED” by indicating the correct “shipping_line_number”

Here is an example of an order.create message:

....
"lines": [
            {
                "id": "358",
                "line_number": 1,
                "product_type": "PHYSICAL",
                "sku": "24-WG083-blue",
                "product_name": "Sprite Stasis Ball 75 cm",
                "shipping_line_number": 4,
                "shipping_address_reference": "335",
                "payment_reference": "170",
                "amount": {...},
                "status": "PRESHIPPED",
                "source_location": "WAREHOUSE_1",
                "promotions_info": {...}
            },
            {
                "id": "358",
                "line_number": 2,
                "product_type": "PHYSICAL",
                "sku": "24-WG084",
                "product_name": "Sprite Foam Yoga Brick",
                "parent_line_id": "357",
                "shipping_line_number": 4,
                "shipping_address_reference": "335",
                "payment_reference": "170",
                "amount": {...},
                "promotions_info": {...}
            },
            {
                "id": "SHIPPING",
                "line_number": 3,
                "product_type": "SHIPPING",
                "sku": "STANDARD",
                "product_name": "Shipping",
                "shipping_address_reference": "335",
                "payment_reference": "170",
                "amount": {...},
                "promotions_info": {...}
            }
            {
                "id": "SHIPPING",
                "line_number": 4,
                "product_type": "SHIPPING",
                "sku": "PRESHIPPED",
                "product_name": "PRESHIPPED",
                "shipping_address_reference": "335",
                "payment_reference": "170",
                "amount": {...},
                "promotions_info": {...}
            },

        ]
....