Skip to content

AppCreateOrderFulfillment

POST
/apps/orders/{id}/fulfillments
curl --request POST \
--url https://your-store.myciqra.com/apps/orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/fulfillments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "lines": [ { "orderLineId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "quantity": 1 } ], "notifyCustomer": true, "trackingCarrier": "example", "trackingNumber": "example", "trackingUrl": "example" }'

Required scope: write_fulfillments — an installation token without it receives 403.

id
required
string format: uuid
Media typeapplication/json
One of:
null
Examplegenerated
{
"lines": [
{
"orderLineId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"quantity": 1
}
],
"notifyCustomer": true,
"trackingCarrier": "example",
"trackingNumber": "example",
"trackingUrl": "example"
}

OK

Media typeapplication/json
object
completesOrder
required
boolean
fulfillment
required
object
createdAt
required
string format: date-time
id
required
string format: uuid
lines
required
Array<object>
object
orderLineId
required
string format: uuid
quantity
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
notifyCustomer
required
boolean
sequence
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
trackingCarrier
required
null | string
trackingNumber
required
null | string
trackingUrl
required
null | string
status
required
Allowed values: PendingPayment AwaitingCollection Paid PaymentFailed Processing Shipped Delivered Completed Cancelled Refunded Returned AwaitingApproval Procurement ReadyForShipment PartiallyRefunded PartiallyCancelled PartiallyFulfilled
Example
{
"status": "PendingPayment"
}