GenericDocument payload – Type 7 – Supplier Deal File
Field | Description | Type | Default value |
DealDocumentUid | The unique GUID identifying this document, if not provided in the original data from the supplier this will be set by PharmX. | GUID | N/A |
Created | The (UTC) date and time the document was created by the supplier, if not provided in the original data from the supplier this will be set by PharmX. | DateTime | N/A |
LineCount | The count of deal lines in the message | Int32 | N/A |
Deals | An array of DealLine |
|
|
DealLine
Field | Description | Type | Default value |
DealId | The deal identifier/name, if not provided in the original data from the supplier this will be set by PharmX. | Varchar(250) | Empty string |
DealType | Defines how the deal is defined and calculated. Currently supported deal types are: 1 The deal is a discount based on a quantity threshold being met 2 The deal is a bonus quantity (and discount if applicable) based on a quantity threshold being met | Int32 | 1 |
ValidFrom | The (UTC) date and time from which the deal starts | DateTime | 1990-01-01T00:00:00Z |
ValidTo | The (UTC) date and time the deal ends | DateTime | 1990-01-01T00:00:00Z |
ReorderNumber | The supplier product code for the item supplied | Varchar(20) | N/A |
GroupingUid | The client should use this field to determine which products can be counted to the deal quantity threshold for a given group. One or more products may be included in a deal group. | GUID | N/A |
Ean | EAN of line | Varchar(50) | Empty string |
Description | Description of item | Varchar(80) | Empty string |
DealQuantityThreshold | The quantity of products in a deal group required to achieve the discount | Int32 | 0 |
UOM | The Unit of measure, currently defined values are: | Varchar(10) | EA |
DealDiscount | The percentage of discount applied to the line if the DealQuantityThreshold is met | Decimal | null |
DealDiscountCostExGst | The dollar discount per unit applied to the line if the DealQuantityThreshold is met | Decimal | null |
DealBonusQuantity | The quantity of bonus products in a deal group if the DealQuantityThreshold is met | Int32 | 0 |
NormalCost | The list/catalogue cost excluding GST | Decimal | null |
RetailPrice | Recommended Retail Price | Decimal | null |
PromoRetailPrice | Recommended Retail Price | Decimal | null |
Message |
| Varchar(50) | null |