commerce/orders/fulfillment

Use the Fulfillment resource to manage shipments or pickups of collections of packages for an order.

JSON Example

FulfillmentAction Properties

Property Description
actionName

type: string

The name of the action to perform for the payment, fulfillment, order, or return.

Tip:  To retrieve the list of available actions, use an operation like GetAvailableReturnActions to view the actions available for the resource you are updating.

digitalPackageIds

type: list of string

The digital package ID identifies the package to update on the order.

packageIds

type: list of string

Array list of unique IDs of packages in a shipment planned for or finished a shipping fulfillment action.

pickupIds

type: list of string

Array list of in-store pickups for which to perform the fulfillment action.

Operations

Operation Name Request URI Description
PerformFulfillmentAction POST %7borderId%7d%2ffulfillment%2factions%2f%3fresponseFields%3d%7bresponseFields%7d

Sets the fulfillment action to "Ship" or "PickUp". To ship an order or prepare it for in-store pickup, the order must have a customer name, the "Open" or "OpenAndProcessing" status. To ship the order, it must also have the full shipping address and shipping method. Shipping all packages or picking up all pickups for an order will complete a paid order.

ResendPackageFulfillmentEmail POST %7borderId%7d%2ffulfillment%2femail%2fresend%3fresponseFields%3d%7bresponseFields%7d

Resends an email with details about the package fulfillment to the shopper.