---
schema_version: "1"
id: 06a2b27a9d6e1af6546c8da904dcdde6352268671def20140d5fddb3b54d7acf
title: Get Order SPI Reference
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/commerce-cloud/retail-cloud/guides/get-order-spi-reference.md
canonical_url: https://developer.salesforce.com/docs/commerce/retail-cloud/guide/get-order-spi-reference.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: 22cca1db309ab23a0933ce8416d7921718673c6ac3986670c00bf6917897689d
products:
  - Point of Sale for Developers
  - Salesforce APIs
---
# Get Order SPI Reference

The table below provides sample JSON schemas for specific use cases when using the Point of Sale [Get Order SPI](https://developer.salesforce.com/docs/commerce/retail-cloud/guide/retail-cloud-api-spi-webhook-specs.html).

| **Use Case**                                                                                                                             | **Refer to Attribute**                                                                                                                                                                                                           | **Notes**                                                                                   |
| ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| **Sale**                                                                                                                                 |                                                                                                                                                                                                                                  |                                                                                             |
| [Single-item sale](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/GetOrderSPI_singleItemSale.json)                     | orderProductList                                                                                                                                                                                                                 |                                                                                             |
| [Multi-item sale](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/GetOrderSPI_multiItemSale.json)                       | orderProductList                                                                                                                                                                                                                 |                                                                                             |
| [Sale with customer](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/GetOrderSPI_saleWithCustomer.json)                 | customerProfile<br>email<br>phoneNumber<br>billingAddress                                                                                                                                                                        |                                                                                             |
| [Item-level discount](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/GetOrderSPI_itemLevelDiscount.json)               | priceOverrideReason<br>priceOverrideReasonCode<br>orderProductList.priceAdjustments<br>orderProductList.discount<br>orderProductList.promotionTitle<br>orderProductList.reasons<br>productPriceAdjustments<br>reasons            | • To calculate item-level discounts, use orderProductList.price - orderProductList.discount |
| [Transaction-level discount](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/GetOrderSPI_transactionLevelDiscount.json) | orderProductList.priceAdjustments<br>orderProductList.discount<br>orderProductList.promotionTitle<br>orderProductList.reasons<br>productPriceAdjustments<br>reasons<br>transactionDiscountAmount<br>transactionDiscountReason    |                                                                                             |
| [Promotion](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/GetOrderSPI_promotion.json)                                 | orderProductList.priceAdjustments<br>orderProductList.discount<br>orderProductList.promotionTitle<br>orderProductList.reasons<br>productPriceAdjustments                                                                         |                                                                                             |
| [Single-Use Promotion Code (SUPC)](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/GetOrderSPI_SUPC.json)               | priceOverrideReason<br>priceOverrideReasonCode<br>orderProductList.priceAdjustments<br>orderProductList.discount<br>orderProductList.promotionTitle<br>orderProductList.reasons<br>productPriceAdjustments<br>reasons<br>coupons |                                                                                             |
| [Tax exemption](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/GetOrderSPI_taxExempt.json)                             | taxExemptions<br>orderProductList.taxExemption<br>orderProductList.productTax.taxExemption                                                                                                                                       |                                                                                             |
| [Item-level note](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/GetOrderSPI_itemLevelDiscount.json)                   | orderProductList.notesList                                                                                                                                                                                                       |                                                                                             |
| [Order-level note](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/GetOrderSPI_notes.json)                              | notesList                                                                                                                                                                                                                        |                                                                                             |
| [Split sales attribution](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/GetOrderSPI_splitTender.json)                 | orderProductList.salesAssociateAttribution                                                                                                                                                                                       |                                                                                             |
| **Sale / Omni**                                                                                                                          |                                                                                                                                                                                                                                  |                                                                                             |
| [Charge & send / Endless aisle](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/GetOrderSPI_endlessAisle.json)          | shippingAddress<br>orderProductList.omniFulfillmentType                                                                                                                                                                          | • omniFulfillmentType = SHIP_TO_HOME                                                        |
| [Ship from store / Ship from another store](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/GetOrderSPI_shipFromStore.json) | fulfillmentType<br>fulfillmentsubtype<br>shippingAddress<br>orderProductList.fulfillmentLocation<br>orderProductList.omniFulfillmentLocationType<br>orderProductList.omniFulfillmentType                                         | • omniFulfillmentLocationType: Regular<br>• omniFulfillmentType: SHIP_TO_HOME_CURRENT_STORE |
| **Tenders**                                                                                                                              |                                                                                                                                                                                                                                  |                                                                                             |
| [Cash payment](https://support.predictspring.com/hc/article_attachments/29585192623379)                                                  | tenders.paymentMethod<br>tenders.cardType                                                                                                                                                                                        |                                                                                             |
| [Credit card payment](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/GetOrderSPI_creditCardPayment.json)               | requestId<br>paymentDetails.alternateRequestId<br>paymentDetails.authorizationDate<br>paymentDetails.cardExpirationMonth<br>paymentDetails.cardExpirationYear<br>paymentDetails.cardNumber<br>paymentDetails.fundingSource       | • fundingSource = CREDIT                                                                    |
| [Debit card payment](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/GetOrderSPI_debitCardPayment.json)                 | requestId<br>tenders.alternateRequestId<br>tenders.authorizationDate<br>tenders.cardExpirationMonth<br>tenders.cardExpirationYear<br>tenders.cardNumber<br>tenders.fundingSource                                                 | • fundingSource = DEBIT                                                                     |
| [Gift card payment](https://support.predictspring.com/hc/article_attachments/29585208262675)                                             | requestId<br>tenders.alternateRequestId<br>tenders.authorizationDate<br>tenders.cardExpirationMonth<br>tenders.cardExpirationYear<br>tenders.cardNumber<br>tenders.fundingSource                                                 |                                                                                             |
| [Miscellaneous payment](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/GetOrderSPI_misc.json)                          | tenders.accountNumber<br>tenders.externalPaymentReferenceId<br>tenders.requestId                                                                                                                                                 |                                                                                             |
| [Split payment](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/GetOrderSPI_splitTender.json)                           | requestId<br>tenders.alternateRequestId<br>tenders.authorizationDate<br>tenders.cardExpirationMonth<br>tenders.cardExpirationYear<br>tenders.cardNumber<br>tenders.fundingSource                                                 | • paymentDetails will show two payment objects if paid with two tenders                     |
| [In-store pay by link](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/GetOrderSPI_instorePaybylink.json)               | requestId<br>tenders.alternateRequestId<br>tenders.authorizationDate<br>tenders.cardExpirationMonth<br>tenders.cardExpirationYear<br>tenders.cardNumber<br>tenders.fundingSource<br>tenders.paymentSource                        | • paymentMethod = Paybylink<br>• paymentSource = Paybylink                                  |
| [Remote pay by link](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/GetOrderSPI_remotePaybylink.json)                  | requestId<br>tenders.alternateRequestId<br>tenders.authorizationDate<br>tenders.cardExpirationMonth<br>tenders.cardExpirationYear<br>tenders.cardNumber<br>tenders.fundingSource<br>tenders.paymentSource                        | • paymentMethod = RemotePaybylink<br>• paymentSource = RemotePaybylink                      |

<!-- ## Unreferenced attachments:

- title=Get Order SPI Reference, img=single_item_sale_json, inline=False
- title=Get Order SPI Reference, img=promotion_json, inline=False
- title=Get Order SPI Reference, img=multi_item_sale_json, inline=False
- title=Get Order SPI Reference, img=attribution_json, inline=False
- title=Get Order SPI Reference, img=item_level_discount_json, inline=False
- title=Get Order SPI Reference, img=supc_json, inline=False
- title=Get Order SPI Reference, img=sale_with_customer_json, inline=False
- title=Get Order SPI Reference, img=transaction_level_discount_json, inline=False
- title=Get Order SPI Reference, img=notes_json, inline=False
- title=Get Order SPI Reference, img=tax_exempt_json, inline=False
- title=Get Order SPI Reference, img=ship_from_store_json, inline=False
- title=Get Order SPI Reference, img=debit_card_payment_json, inline=False
- title=Get Order SPI Reference, img=credit_card_payment_json, inline=False
- title=Get Order SPI Reference, img=remote_paybylink_json, inline=False
- title=Get Order SPI Reference, img=instore_paybylink_json, inline=False
- title=Get Order SPI Reference, img=endless_aisle_json, inline=False
- title=Get Order SPI Reference, img=split_tender_json, inline=False
- title=Get Order SPI Reference, img=misc_json, inline=False -->