AppGetOrder
GET
/apps/orders/{id}
const url = 'https://your-store.myciqra.com/apps/orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string format: uuid
Responses
Section titled “Responses”OK
Media typeapplication/json
object
archivedAt
required
null | string format: date-time
billingAddress
required
One of:
null
object
city
required
null | string
country
required
null | string
district
required
null | string
line1
required
null | string
line2
required
null | string
name
required
null | string
neighbourhood
required
null | string
phone
required
null | string
postalCode
required
null | string
state
required
null | string
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
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
notifyCustomer
required
boolean
sequence
required
integer | string format: int32
trackingCarrier
required
null | string
trackingNumber
required
null | string
trackingUrl
required
null | string
giftCardTotal
required
number | string format: double
hasCarrierLabel
required
boolean
id
required
string format: uuid
invoice
required
lines
required
Array<object>
object
compareAtUnitPrice
required
null | number | string format: double
currency
required
string
discountAmount
required
number | string format: double
fulfilledQuantity
required
integer | string format: int32
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
value
required
string
quantity
required
integer | string format: int32
sku
required
null | string
surchargeUnit
required
number | string format: double
unitPrice
required
number | string format: double
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
status
required
string
shippingAddress
required
One of:
null
object
city
required
null | string
country
required
null | string
district
required
null | string
line1
required
null | string
line2
required
null | string
name
required
null | string
neighbourhood
required
null | string
phone
required
null | string
postalCode
required
null | string
state
required
null | string
shippingCountry
required
null | string
shippingTotal
required
number | string format: double
status
required
tags
required
Array<string>
taxTotal
required
number | string format: double
total
required
number | string format: double
trackingCarrier
required
null | string
trackingNumber
required
null | string
trackingUrl
required
null | string
Example
{ "status": "PendingPayment"}