Response Object – ExtendedInfo
A typed key-value pair object is utilised to allow the inclusion of custom data in selected gateway requests while avoiding breaking changes to the data models.
An ExtendInfo may represent data to be persisted to gateway documents and/or trigger customised code logic.
ExtendedInfo entries should only be included in requests if advised by the PharmX team.
Field | Type | Description |
|---|---|---|
Name | string (150) | The value name |
Type | string (150) | The data type of the value |
Value | string (150) | The value itself |
Known ExtendedInfo Values
Currently defined values for extended info data that may be found in production data are listed in the table below.
Name | Type | Description |
|---|---|---|
SSCC | “string” | An extended property of the GatewayOrderAcknowledgementLine and GatewayInvoiceLine. The SSCC identifies the container/carton/tote the product has been shipped in. Is similar to the current “Tote” value in invoice lines but provides a greater level of detail of the supplied item is spread across multiple totes/cartons as multiple SSCC data may be provided for a single order line. Value will be formatted as “<SSCC>;<quantity>”, e.g. “026645386510829200;5”. A typical use case might be the POS user scanning the SSCC barcode on a carton as it arrives in store to aid the verification of expected items and quantities. |
supplierInvoiceDate | “datetime” | An extended property for GatewayInvoiceDocument. Provides the supplier invoice created date, which may differ from the GatewayInvoiceDocument’s Formatted as UTC, e.g. “2019-04-10T01:14:52Z”. If a due date has not been provided by the supplier this value may be used to accurately assess a payment date for the invoice. |