Skip to content
OpenShop Logo OpenShop

Admin Order Details

GET
/admin/order/details

GET order details based on orderId and storeId

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
orderId
required
number

Responses

Section titled “ Responses ”

200

Section titled “200 ”

GET order details based on orderId and storeId

object
order
required
object
id
required
number
orderNumber
required
number
createdOn
required
string
completedOn
required
string | null
cancelledOn
required
string | null
subtotal
required
string
discountTotal
required
string
shippingTotal
required
string
taxTotal
required
string
currencyId
required
number
currencyCode
required
string
grandTotal
required
string
shippingMethod
required
string | null
customerNote
required
string | null
adminNotes
required
string | null
paymentStatus
required
fulfillmentStatus
required
refundStatus
required
Any of:
subscriptions
required
Array<object>
object
id
required
number
subscriptionNumber
required
number
additionalData
required
Any of:
object
enrollment
object
dateOfBirth
required
string
mobileOS
required
string
Allowed values: ANDROID IOS
referralHandle
required
string
referralCode
string
orderItems
required
Array<object>
object
id
required
number
name
required
string
sku
required
string | null
variantDisplay
required
string | null
unitPrice
required
string
compareAtPrice
required
string | null
discountTotal
required
string | null
taxTotal
required
string | null
basePriceLineTotal
required
string
lineTotal
required
string
quantity
required
number
subscriptionIntervalCount
required
number | null
subscriptionIntervalUnit
required
Any of:
productImageUrl
required
string | null
productType
required
string
Allowed values: ENROLLMENT STANDARD
orderCustomer
required
object
userId
required
number
email
required
string
firstName
required
string | null
lastName
required
string | null
phoneNumber
required
string | null
phoneCountry
required
string | null
isGuest
required
boolean
orderShipping
required
object
shippingAddress
required
object
firstName
required
string
lastName
required
string
company
required
string | null
email
required
string | null
streetLine1
required
string
streetLine2
required
string | null
city
required
string
stateProvince
required
string
postalCode
required
string
countryCode
required
string
shippingNotes
required
string | null
shipments
required
Array<object>
object
id
required
number
carrierName
required
string | null
trackingNumber
required
string | null
trackingUrl
required
string | null
shippedOn
required
string | null
estimatedDelivery
required
string | null
provider
required
string
providerShipmentId
required
string | null
status
required
items
required
Array<object>
object
orderItemId
required
number
quantity
required
number
orderPayment
required
Any of:
object
provider
required
string
paymentType
required
string
amount
required
string
status
required
transactionId
required
string | null
lastFour
required
string | null
expiryMonth
required
string | null
expiryYear
required
string | null
brand
required
string | null
coupons
required
Array<object>
object
code
required
string
type
required
string
Allowed values: PERCENTAGE FIXED_AMOUNT FREE_SHIPPING
discountAmount
required
string