Endpoint to take in order and item information from a partner, and generated the best shipment plan based on their configured fulfillment network.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Parameters passed in from which a plan is generated.

string

Optional Id which allows partners to set their own Id for looking up the plan after creation.

date-time

Date used to re-create a plan as of a certain point in time. This parameter will prevent the use of caching for this request. The most common use case is to provide null which represents 'now'.

orders
array of objects
required

List of orders to plan.

orders*
productDetails
array of objects

Product details and inventory. May be omitted when assumeQuantityAvailableInfinite is true and no fulfillmentCenters scope is supplied (infinite inventory is then assumed for every ordered product in all of the partner's contexts).

productDetails
boolean

When true, planning assumes infinite inventory. Scope is the fulfillment contexts referenced by fulfillmentCenters when that field is non-empty; otherwise all of the partner's contexts. In the all-contexts case omit productDetails — this flag already assumes every product is infinite everywhere; to supply per-product attributes (e.g. dimensions or weight) set assumeQuantityAvailableInfinite on each ProductDetail instead, which keeps those attributes. When a fulfillmentCenters scope is supplied, productDetails may still carry inventoryStatuses describing OTHER (non-scope) contexts. Defaults to false/null.

packagingTypes
array of objects

Packaging type overrides across all fulfillment centers. If provided will override all preconfigured packaging types for the planning activity.

packagingTypes
date-time

Future date to use as the starting date of the plan. A value of null conveys to use 'now' as the plan time.

fulfillmentCenters
array of objects

Data overrides (e.g. packaging types) at the fulfillment center level. Each entry identifies the fulfillment context it applies to. When assumeQuantityAvailableInfinite (request-level or product-level) is true and this field is non-empty, the referenced contexts also define the scope in which infinite inventory is assumed.

fulfillmentCenters
string

Optional short form name for the generated plan. Used to give the plans human readable attributes to help identify plans in UIs and spread sheets.

string

Optional long form information for the generated plan.

string

Either the shipium tenant ID or the partner provided tenant ID. When present, this is used to indicate the tenant associated with the plan.

Headers
string
string
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json