Order types

More Facilities-API information can be found here: REST API documentation - Orders

Ship-from-Store

Ship-from-Store (SfS) are shipped from a facility to an address. The Order.deliveryPreferences are used to mark the order for shipping. Typically, a shipping label is needed for the parcels to be sent.

• Order.deliveryPreferences mark an order as a shipping order:

  • preferredCarriers: Used to select the (logistics) carrier that was chosen for delivery.

  • serviceLevel: Could be either DELIVERY for standard shipping, or SAMEDAY for same-day delivery.

  • Note, there is no targetTime attribute as this is calculated by the fulfillmenttools platform, depending on the facility and carrier configuration.

  • desiredDeliveryTime: contains the selected delivery time of the customer within the shop's checkout. This, in combination with the reservation preference mode, defines when we check for stock reservation.

  • The reservationPreferences are used in cases where the order cannot be fulfilled and the respective stock cannot be reserved directly after the routing is performed. This is the case if the consumer places an order where the delivery date is further in the future (see desiredDeliveryTime ) and the stock should not be reserved instantly (e.g., if the items do have a best-before date).

• The Order.consumer.email address is forwarded to the logistics carrier when a shipping label is requested. Make sure you have the customer's consent to process this data. Otherwise, supply a generic email address.

Click-and-Collect

Click-and-Collect (C&C) orders are picked up by the customer in the store. When placing an order with the fulfillmenttools platform, the Order.deliveryPreferences are used to mark the order for collection.

• Order.deliveryPreferences mark an order as a collect order:

  • paid flag is used as a signal that the order has already been paid by the customer. For Click-and-Reserve orders, this flag must be set to false.

  • provisioningTime is the appointment time when the customer wants to pick up the order at the location (for example, when a pickup time slot is presented in the eCommerce shop during checkout). It is also necessary to change this appointment time during the fulfillment process (i.e., when the customer changed plans). Based on the provisioningTime it is possible to configure a timeframe after which the order gets canceled automatically in case the customer does not show up (see expiry).

  • facilityRef is used to select the facility where the order will be picked up by the customer. This must be a valid facility id. See the Add and Manage Facilities example for details on facilities.

Locked orders

There are use cases where not every order should be fulfilled as soon as possible. In some cases, it might be necessary to do some manual checks on an order, e.g. customer verification or fraud detection. Locked orders are routed to a facility but do not result in a pick job until they are unlocked.

To lock an order, set the "status": "LOCKED" at order creation. To unlock an order, use the /api/orders/{orderId}/actions endpoint.