Skip to main content
Order fulfillmentsVersion: v3

Create order fulfillment

POST/payments/orders/{orderId}/fulfillments

The "Order Fulfillment" API facilitates the process of fulfilling an order.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:payments/orders.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Path Parameters

orderIdstringrequired

ID of the order that needs to be returned

Example:653f5e0cde5a1314e62a837c

Body

altIdstringrequired

Location Id or Agency Id

Example:6578278e879ad2646715ba9c
altTypestringrequired
Available optionslocation
trackingsobject[]required

Fulfillment tracking information

itemsobject[]required

Fulfilled items

notifyCustomerbooleanrequired

Need to send a notification to customer

Example:true

Response

Successful response

statusbooleanrequired

Status of api action

Example:true
dataobjectrequired

fulfillment data