|
bLoyal API Documention and Samples |
Type SalesTransactionLine
Contains elements as defined in the following table.
| Component | Type | Description |
|---|---|---|
|
||
| Discount | decimal | The per quantity based discount (if any) for the line item. This amount needs to multipled by the Quantity. |
| ExternallyAppliedDiscount | boolean | This should be set to False unless your system applied the discount. If set to True then bLoyal will bypass this line item and not calculate any bLoyal discounts |
| LookupCode | string | The unique product lookup code or SKU number. |
| OrderDiscount | decimal |
The amount of any order discounts that was applied to this line item. The total discount for the line item is calculated as follows. (Discount * Quatity) - OrderDiscount |
| Price | decimal | The price the item was being sold for. |
| PriceSource | PriceSource | Specifies where the original source where price came from. In most cases this is the Base Price. |
| ProductExternalId | string | Your unique product Id for the product on the line item. |
| ProductId | int | [Optional] The unique bLoyal product Id |
| ProductName | string | The name of the product. This will be included on the sales transaction |
| Quantity | decimal |
The quantity for the item. The total extended amount fo the line item is calculated as follows: (Price * Quantity) - [(Discount * Quantity) - OrderDiscount] |
| ReasonCode | string | The discount reason code if a discount was applied. This is used for reporting and for showing to the cashier and customer on the receipt |
| ShipmentNumber | int | [Optional] If this is a multi-shipment shipping order then this is the shipment number this line item applies to. This field only needs to be set for multi-shipment orders. |
| TaxDetails | ArrayOfTaxDetail | If tax was applied to this line item then you should provide the details of the tax amount and tax code applied. |
| VariantDimension1 | string | [Optional] product dimention value #1 if this was part of a matric product and your systme does not have a unique lookup code (SKU) for matrix component products. |
| VariantDimension2 | string | [Optional] product dimention value #2 if this was part of a matric product and your systme does not have a unique lookup code (SKU) for matrix component products. |
| VariantDimension3 | string | [Optional] product dimention value #3 if this was part of a matric product and your systme does not have a unique lookup code (SKU) for matrix component products. |
| VariantDimension4 | string | [Optional] product dimention value #4 if this was part of a matric product and your systme does not have a unique lookup code (SKU) for matrix component products. |