Get Cart Order Details API

Fetch full details of a cart order by orderId, including delivered vouchers and per-product delivery status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request Schema

ParameterTypeDescription
orderIdIntUnique order ID returned by Place Cart Order API.

Response Schema

PathTypeDescription
dataobjectRoot response object.
data.getCartOrderDetailsobjectContainer for cart order details.
data.getCartOrderDetails.statusnumberAPI execution status (1 = success).
data.getCartOrderDetails.dataobjectOrder details payload.
data.getCartOrderDetails.data.orderIdnumberUnique order ID.
data.getCartOrderDetails.data.orderTotalnumberRounded total amount.
data.getCartOrderDetails.data.rawOrderTotalnumberExact unrounded amount.
data.getCartOrderDetails.data.orderDiscountstringDiscount applied; may be blank.
data.getCartOrderDetails.data.rawOrderDiscountstringExact unrounded discount.
data.getCartOrderDetails.data.currencyCodestringCurrency code.
data.getCartOrderDetails.data.currencyValuenumberFX multiplier.
data.getCartOrderDetails.data.amountChargednumberFinal charged amount.
data.getCartOrderDetails.data.orderStatusstringOrder completion status.
data.getCartOrderDetails.data.deliveryStatusstringDelivery status.
data.getCartOrderDetails.data.tagstringCustom tag from request.
data.getCartOrderDetails.data.orderDatestringOrder creation timestamp.
data.getCartOrderDetails.data.deliveryDatestringDelivery timestamp.
data.getCartOrderDetails.data.shippingDetailsobject/nullShipping details (merchandise only; null otherwise).
data.getCartOrderDetails.data.vouchersarrayDelivered voucher objects.
data.getCartOrderDetails.data.vouchers[].productIdnumberProduct ID.
data.getCartOrderDetails.data.vouchers[].orderIdnumberOrder ID.
data.getCartOrderDetails.data.vouchers[].voucherCodestringVoucher code / redemption URL.
data.getCartOrderDetails.data.vouchers[].pinstringPIN (if applicable).
data.getCartOrderDetails.data.vouchers[].validitystringExpiry date.
data.getCartOrderDetails.data.vouchers[].amountnumberVoucher amount.
data.getCartOrderDetails.data.vouchers[].currencystringVoucher currency.
data.getCartOrderDetails.data.vouchers[].countrystringCountry code.
data.getCartOrderDetails.data.vouchers[].typestringDelivery type (code, codePin, url, urlPin).
data.getCartOrderDetails.data.vouchers[].currencyValuenumberFX multiplier for the voucher.
data.getCartOrderDetails.data.orderProductsarraySummary of ordered products.
data.getCartOrderDetails.data.orderProducts[].orderProductIdnumberOrder product line ID.
data.getCartOrderDetails.data.orderProducts[].productIdnumberProduct ID.
data.getCartOrderDetails.data.orderProducts[].productNamestringProduct name.
data.getCartOrderDetails.data.orderProducts[].currencyCodestringProduct currency.
data.getCartOrderDetails.data.orderProducts[].orderProductStatusstringDelivery status for this product.
data.getCartOrderDetails.data.orderProducts[].denominationnumberProduct denomination.
data.getCartOrderDetails.data.orderProducts[].quantitynumberQuantity ordered.
data.getCartOrderDetails.data.orderProducts[].discountPercentnumberDiscount percent applied.

Implementation Notes

  1. vouchers[] contains the delivered voucher codes; orderProducts[] summarizes each ordered product and its per-product status.
  2. type indicates how the voucher is delivered (code, codePin, url, urlPin).
  3. The response fields above are taken from an actual staging response.
Body Params
string
required
Defaults to plumProAPI.mutation.getCartOrderDetails

Please use 'plumProAPI.mutation.getCartOrderDetails' always in query

string
required
Defaults to plumProAPI

Please use 'plumProAPI' always in query

variables
object
required
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json