Skip to content
OpenShop Logo OpenShop

Get an Order Summary

GET
/order/summary

Returns an order summary that includes tax and shipping calculations for the user or anonymous user.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Returns an order summary that includes tax and shipping calculations for the user or anonymous user.

object
id
required
number
itemCount
required
number
currencyCode
required
string
currencySymbol
required
string
decimalPlaces
required
number
subtotal
required
string
savingsTotal
required
string
itemTotal
required
string
items
required
Array<object>
object
id
required
number
productId
required
number
productType
required
string
Allowed values: STANDARD ENROLLMENT
isVirtual
required
boolean
productName
required
string
sku
required
string | null
productSlug
required
string
primaryImageUrl
required
string | null
variantId
required
number | null
variantDisplay
required
string | null
quantity
required
number
unitPrice
required
string
lineTotal
required
string
compareAtLineTotal
required
string
basePriceLineTotal
required
string
subscriptionPlan
required
Any of:
object
id
required
number
name
required
string
intervalUnit
required
intervalCount
required
number
warnings
object
removedItems
required
Array<object>
object
productId
required
number
variantId
required
number | null
subscriptionPlanId
required
number | null
reason
required
string
Allowed values: OUT_OF_STOCK NO_LONGER_AVAILABLE DUPLICATE_ENROLLMENT_ITEM
adjustedItems
required
Array<object>
object
productId
required
number
variantId
required
number | null
subscriptionPlanId
required
number | null
requestedQuantity
required
number
availableQuantity
required
number
reason
required
string
Allowed values: INSUFFICIENT_STOCK ENROLLMENT_ITEM_QUANTITY_ADJUSTED
shippingCost
required
string | null
taxTotal
required
string | null
grandTotal
required
string
couponDiscount
required
string | null
couponCode
required
string | null