Skip to content

AppGetOrder

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

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

id
required
string format: uuid

OK

Media typeapplication/json
object
archivedAt
required
null | string format: date-time
billingAddress
required
One of:
null
billingSameAsShipping
required
boolean
canFulfil
required
boolean
createdAt
required
string format: date-time
currency
required
string
customerEmail
required
null | string
customerId
required
null | string format: uuid
customerNote
required
null | string
discountTotal
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
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
giftCardTotal
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
hasCarrierLabel
required
boolean
id
required
string format: uuid
invoice
required
One of:
null
lines
required
Array<object>
object
compareAtUnitPrice
required
null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
currency
required
string
discountAmount
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
fulfilledQuantity
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
id
required
string format: uuid
name
required
string
options
required
null | string
properties
required
Array<object> | null
object
label
required
string
surcharge
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
value
required
string
quantity
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
sku
required
null | string
surchargeUnit
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
unitPrice
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
note
required
null | string
orderNumber
required
string
paymentMethod
required
null | string
paymentStatus
required
null | string
personalDataRedacted
required
boolean
returns
required
Array<object>
object
createdAt
required
string format: date-time
id
required
string format: uuid
isExchange
required
boolean
reason
required
string
requestedAmount
required
null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
status
required
string
shippingAddress
required
One of:
null
shippingCountry
required
null | string
shippingTotal
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
status
required
Allowed values: PendingPayment AwaitingCollection Paid PaymentFailed Processing Shipped Delivered Completed Cancelled Refunded Returned AwaitingApproval Procurement ReadyForShipment PartiallyRefunded PartiallyCancelled PartiallyFulfilled
tags
required
Array<string>
taxTotal
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
total
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
trackingCarrier
required
null | string
trackingNumber
required
null | string
trackingUrl
required
null | string
Example
{
"status": "PendingPayment"
}