Skip to content

Fulfillment

Manage locations, fulfillment, packages, shipments, and routing.

Fields

idstringUnique identifier of the resource.
namestring
codestring
typeenumwarehouse · store · seller
statestring
emailstring
sellerNamestring
addressstring
See all 44 fields
citystring
countrystring
postalCodestring
latitudenumber
longitudenumber
phonestring
descriptionstring
isActiveboolean
isDefaultboolean
useForFulfillmentboolean
sourceOwnedboolean
supportsShippingboolean
supportsLocalDeliveryboolean
supportsPickupboolean
isPhysicalStoreboolean
supportsPosboolean
priorityinteger
pickupInstructionsstring
pickupLeadTimeInMinutesinteger
pickupSlotInMinutesinteger
pickupDailyCapacityinteger
localDeliveryInstructionsstring
localDeliveryLeadTimeInMinutesinteger
localDeliverySlotInMinutesinteger
localDeliveryDailyCapacityinteger
localDeliveryFeenumber
localDeliveryFreeFromAmountnumber
localDeliveryMinHoursinteger
localDeliveryMaxHoursinteger
localDeliveryPostalCodesarray<string>
localDeliveryZonesarray<object>
schedulesarray<object>
createdOnstringTimestamp when the resource was created, in ISO 8601.
updatedOnstringTimestamp when the resource was last modified, in ISO 8601.
storeIdstring
sellerIdstring

Operations

MethodEndpointOperation
POST/v1/fulfillment/routing/previewPreview routing

Locations

MethodEndpointOperation
POST/v1/fulfillment/locationsCreate location
GET/v1/fulfillment/locationsList locations
GET/v1/fulfillment/locations/{id}Get location by ID
PUT/v1/fulfillment/locations/{id}Update a location
DELETE/v1/fulfillment/locations/{id}Delete a location

Orders

MethodEndpointOperation
GET/v1/fulfillment/ordersList fulfillment orders
POST/v1/fulfillment/orders/packing-slipsGet packing slips batch
GET/v1/fulfillment/orders/{id}Get fulfillment order
POST/v1/fulfillment/orders/{id}/assignAssign fulfillment order
POST/v1/fulfillment/orders/{id}/cancelCancel fulfillment order
POST/v1/fulfillment/orders/{id}/deliverDeliver fulfillment order
POST/v1/fulfillment/orders/{id}/in-progressSet fulfillment order in progress
POST/v1/fulfillment/orders/{id}/pick-upPick up fulfillment order
POST/v1/fulfillment/orders/{id}/ready-to-pickupSet fulfillment order ready to pick up
POST/v1/fulfillment/orders/{id}/shipShip fulfillment order
POST/v1/fulfillment/orders/{id}/shipmentCreate fulfillment shipment
POST/v1/fulfillment/orders/batch/assignAssign fulfillment orders to a location
POST/v1/fulfillment/orders/labels/exportsExport shipping labels
POST/v1/fulfillment/orders/packing-slips/exportsExport packing slips
GET/v1/fulfillment/orders/{id}/packing-slipGet packing slip
GET/v1/fulfillment/orders/{id}/shipments/{shipmentId}/labelGet shipment label
GET/v1/fulfillment/orders/{id}/shipments/{shipmentId}/packing-slipGet shipment packing slip
GET/v1/fulfillment/orders/{id}/shipments/{shipmentId}/trackingGet shipment tracking
PATCH/v1/fulfillment/orders/{id}/shipments/{shipmentId}/trackingUpdate shipment tracking
GET/v1/fulfillment/orders/{id}/shipments/{shipmentId}/tracking/imageGet shipment tracking image

Packages

MethodEndpointOperation
POST/v1/fulfillment/packagesCreate package
GET/v1/fulfillment/packagesList packages
GET/v1/fulfillment/packages/{id}Get package
PUT/v1/fulfillment/packages/{id}Update package
DELETE/v1/fulfillment/packages/{id}Delete package

Settings

MethodEndpointOperation
GET/v1/fulfillment/settingsGet fulfillment settings
PUT/v1/fulfillment/settingsUpdate fulfillment settings

Last updated: