ReceiptProcess Data Source
From i.STAR Help
Input Variables
None. The receipt is built and processed from the current shopping cart and customer data.
Output Variables
Receipt Variables
| Name | Type | Description | Availability
|
| $receiptId | String | The unique identifier for this receipt. |
|
| $subTotal | Numeric | The receipt's subtotal. |
|
| $discountTotal | Numeric | The receipt's discount total. |
|
| $shippingMethodName | String | The name of the receipt's selected shipping method. |
|
| $upsServiceCode | String | The UPS Service Code if the selected shipping method is tied to UPS. |
|
| $upsServiceCodeID | Numeric | The UPS Service Code ID if the selected shipping method is tied to UPS. |
|
| $upsServiceCodeDescription | String | The UPS Service Code description if the selected shipping method is tied to UPS. |
|
| $shippingBase | Numeric | The receipt's shipping base. |
|
| $shippingPremiums | Numeric | The receipt's shipping premiums. |
|
| $taxTotal | Numeric | The receipt's tax total. |
|
| $total | Numeric | The receipt's total. |
|
| $currentPaymentOptions | Collection | The current payment options that have been used on this receipt. |
|
Gift Registry Receipt Variables
| Name | Type | Description | Availability
|
| $giftRegistryID | String | The unique identifier for the gift registry items were bought from. | 1
|
| $giftFirstName1 | String | The first name of the first person on the gift registry. | 2
|
| $giftLastName1 | String | The last name of the first person on the gift registry. | 2
|
| $giftFirstName2 | String | The first name of the second person on the gift registry. | 2
|
| $giftLastName2 | String | The last name of the second person on the gift registry. | 2
|
Customer Variables
| Name | Type | Description | Availability
|
| $customerFirstName | String | The customer's first name. |
|
| $customerLastName | String | The customer's last name. |
|
| $customerAddress | String | The customer's address. |
|
| $customerCity | String | The customer's city. |
|
| $customerState | String | The customer's state. |
|
| $customerZip | String | The customer's zip code. |
|
| $customerEmail | String | The customer's email address. |
|
Shipping Variables
| Name | Type | Description | Availability
|
| $shipToGift | Boolean | Is this receipt being shipped to a gift registry address. |
|
| $shippingFirstName | String | The shipping recipient's first name. | 3
|
| $shippingLastName | String | The shipping recipient's last name. | 3
|
| $shippingAddress | String | The shipping recipient's address. | 3
|
| $shippingCity | String | The shipping recipient's city. | 3
|
| $shippingState | String | The shipping recipient's state. | 3
|
| $shippingZip | String | The shipping recipient's zip code. | 3
|
Current Payment Options
| Name | Type | Description | Availability
|
| $index | String | The payment method's index. |
|
| $id | String | The payment method's ID. |
|
| $name | String | The payment method's name. |
|
| $isCreditCard | Boolean | Is the payment method a credit card? |
|
| $isGiftCard | Boolean | Is the payment method a gift card? |
|
| $creditCardType | String | The type of credit card being used. |
|
| $creditCardNumber | String | The masked credit card number. |
|
| $creditCardExpirationDate | String | The credit card expiration date. |
|
| $cvv2Code | String | The credit card CVV2 number. |
|
Order Notes
| Name | Type | Description | Availability
|
| $showOrderNotes | Boolean | Are we collecting order notes? |
|
| $orderNotes | String | The order notes that were entered. |
|
| $orderNotesVerbiage | String | What we are calling "order notes". |
|
Variable Availability Notes
- Will be an empty string if there is no gift registry attached to this receipt.
- Only output if there is a gift registry attached to this receipt.
- Only output if there isn't a gift registry attached to this receipt.