Get Order SPI Reference
The table below provides sample JSON schemas for specific use cases when using Retail Cloud's Get Order SPI.
| Use Case | Refer to Attribute | Notes |
|---|---|---|
| Sale | ||
| Single-item sale | orderProductList | |
| Multi-item sale | orderProductList | |
| Sale with customer | customerProfile phoneNumber billingAddress | |
| Item-level discount | priceOverrideReason priceOverrideReasonCode orderProductList.priceAdjustments orderProductList.discount orderProductList.promotionTitle orderProductList.reasons productPriceAdjustments reasons | • To calculate item-level discounts, use orderProductList.price - orderProductList.discount |
| Transaction-level discount | orderProductList.priceAdjustments orderProductList.discount orderProductList.promotionTitle orderProductList.reasons productPriceAdjustments reasons transactionDiscountAmount transactionDiscountReason | |
| Promotion | orderProductList.priceAdjustments orderProductList.discount orderProductList.promotionTitle orderProductList.reasons productPriceAdjustments | |
| Single-Use Promotion Code (SUPC) | priceOverrideReason priceOverrideReasonCode orderProductList.priceAdjustments orderProductList.discount orderProductList.promotionTitle orderProductList.reasons productPriceAdjustments reasons coupons | |
| Tax exemption | taxExemptions orderProductList.taxExemption orderProductList.productTax.taxExemption | |
| Item-level note | orderProductList.notesList | |
| Order-level note | notesList | |
| Split sales attribution | orderProductList.salesAssociateAttribution | |
| Sale / Omni | ||
| Charge & send / Endless aisle | shippingAddress orderProductList.omniFulfillmentType | • omniFulfillmentType = SHIP_TO_HOME |
| Ship from store / Ship from another store | fulfillmentType fulfillmentsubtype shippingAddress orderProductList.fulfillmentLocation orderProductList.omniFulfillmentLocationType orderProductList.omniFulfillmentType | • omniFulfillmentLocationType: Regular • omniFulfillmentType: SHIP_TO_HOME_CURRENT_STORE |
| Tenders | ||
| Cash payment | tenders.paymentMethod tenders.cardType | |
| Credit card payment | requestId paymentDetails.alternateRequestId paymentDetails.authorizationDate paymentDetails.cardExpirationMonth paymentDetails.cardExpirationYear paymentDetails.cardNumber paymentDetails.fundingSource | • fundingSource = CREDIT |
| Debit card payment | requestId tenders.alternateRequestId tenders.authorizationDate tenders.cardExpirationMonth tenders.cardExpirationYear tenders.cardNumber tenders.fundingSource | • fundingSource = DEBIT |
| Gift card payment | requestId tenders.alternateRequestId tenders.authorizationDate tenders.cardExpirationMonth tenders.cardExpirationYear tenders.cardNumber tenders.fundingSource | |
| Miscellaneous payment | tenders.accountNumber tenders.externalPaymentReferenceId tenders.requestId | |
| Split payment | requestId tenders.alternateRequestId tenders.authorizationDate tenders.cardExpirationMonth tenders.cardExpirationYear tenders.cardNumber tenders.fundingSource | • paymentDetails will show two payment objects if paid with two tenders |
| In-store pay by link | requestId tenders.alternateRequestId tenders.authorizationDate tenders.cardExpirationMonth tenders.cardExpirationYear tenders.cardNumber tenders.fundingSource tenders.paymentSource | • paymentMethod = Paybylink • paymentSource = Paybylink |
| Remote pay by link | requestId tenders.alternateRequestId tenders.authorizationDate tenders.cardExpirationMonth tenders.cardExpirationYear tenders.cardNumber tenders.fundingSource tenders.paymentSource | • paymentMethod = RemotePaybylink • paymentSource = RemotePaybylink |