Skip to content

AppGetOrderFulfillments

GET
/apps/orders/{id}/fulfillments
curl --request GET \
--url https://your-store.myciqra.com/apps/orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/fulfillments \
--header 'Authorization: Bearer <token>'

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

id
required
string format: uuid

OK

Media typeapplication/json
object
canFulfil
required
boolean
fulfillments
required
Array<object>
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
lines
required
Array<object>
object
fulfilled
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
name
required
string
orderLineId
required
string format: uuid
ordered
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
remaining
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
orderId
required
string format: uuid
status
required
Allowed values: PendingPayment AwaitingCollection Paid PaymentFailed Processing Shipped Delivered Completed Cancelled Refunded Returned AwaitingApproval Procurement ReadyForShipment PartiallyRefunded PartiallyCancelled PartiallyFulfilled
Example
{
"status": "PendingPayment"
}