Intended Application
To issue a transaction to a member with information about single or multiple products (variable quantity).
Notes
- One of two identifiers can be supplied (Member Account Id or Internal Member Id). If both are supplied, the Account Id is given preference and is used to retrieve the member. If no Internal Member Id is available, enter -1 for this field.
- Each product item type is contained within a TransactionBasketItem array.
- All TransactionBasketItem arrays are contained within the ProductBasket array. The below example only contains one product item. The "Detailed Method" page linked below shows the call with two product items.
- A negative retail value suggests a "return". Quantity must remain positive.
- Inactive Account Ids will not be issued transaction(s) using this call.
- If enabled, the "Check for Duplicate Transaction" option will prevent transaction insertion if there are existing transaction(s) that match both the provided transaction external reference and resulting transaction type.
Input Parameters
PARAMETER |
DATA TYPE | DATA REQUIRED? | FORMATTING | NOTES |
---|---|---|---|---|
WS Security Token |
Alphanumeric |
Yes |
|
|
Member Account Id | Alphanumeric | Yes/No | See Article Notes | |
Internal Member Id | Integer | Yes/No | See Article Notes | |
Location External Reference | Alphanumeric | Yes | ||
Transaction Type External Reference | Alphanumeric | Yes | ||
Local Activity Timestamp | Alphanumeric | Yes | MM/DD/YYYY HH:MM:SS AM/PM | Based on corporate timezone when the token was last saved. |
Transaction External Reference | Alphanumeric | No | Unique key from external system. | |
Product External Reference | Alphanumeric | Yes | ||
Product Quantity | Integer | Yes | Quantity must always be a positive number. | |
Product Total Retail Value | Decimal | Yes | Value = individual product retail value X quantity of products (example: For a quantity of 2 products at $5 each, Product Total Retail Value = $10 | |
Product Total Point Value | Decimal | Yes | Used only when points are directly entered. | |
Product Total Profit Value | Decimal | Yes | Used only when profit is directly entered. | |
Check For Duplicate Transaction | Integer | Yes |
1 = Duplicate check enforced (see article notes). 0 = Duplicate check is bypassed. |
|
Insert Missing Product Items | Integer | Yes |
1 = If missing, product is added. 0 = If missing, transaction is not inserted. |
|
Fetch Updated Member Point Totals | Integer | Yes |
1 = Post-transaction point totals are returned. 0 = No point totals are returned. |
|
Process POS Message Promotion on Success | Integer | Yes |
1 = Relevant messages are returned. 0 = No messages are returned. |
Common Return Codes
0,1,2,100,101,102,301,302,5000,6000,6004,14000,14001,14004
Additional error codes may be generated. Their descriptions can be found by calling GetReturnCodeMessage.
More Information