AppCreateOrderFulfillment
POST
/apps/orders/{id}/fulfillments
const url = 'https://your-store.myciqra.com/apps/orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/fulfillments';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"lines":[{"orderLineId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","quantity":1}],"notifyCustomer":true,"trackingCarrier":"example","trackingNumber":"example","trackingUrl":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string format: uuid
Request Body
Section titled “Request Body”Media typeapplication/json
One of:
null
object
lines
required
Array<object> | null
object
orderLineId
required
string format: uuid
quantity
required
integer | string format: int32
notifyCustomer
required
null | boolean
trackingCarrier
required
null | string
trackingNumber
required
null | string
trackingUrl
required
null | string
Examplegenerated
{ "lines": [ { "orderLineId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "quantity": 1 } ], "notifyCustomer": true, "trackingCarrier": "example", "trackingNumber": "example", "trackingUrl": "example"}Responses
Section titled “Responses”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
notifyCustomer
required
boolean
sequence
required
integer | string format: int32
trackingCarrier
required
null | string
trackingNumber
required
null | string
trackingUrl
required
null | string
status
required
Example
{ "status": "PendingPayment"}