Response Object – GatewayOrderAcknowledgement

Field

Type

Description

Id

int

The unique ID of the order, allocated by the Gateway.

AcknowledgedBySupplier

boolean

Indicates if the order has been processed by the supplier.

ReceivedBySupplier

date/time

The (UTC) date and time stamp of when the order was acknowledged by the supplier.

Status

string (50)

The status of the order; can take the values:

Queued: The order is queued for delivery
Sending: The order is sending to the supplier
Dispatched: The order is awaiting collection by the supplier
Sent: The order has been successfully delivered to the supplier
Cancelled: The order has been cancelled and will not be sent
Retry: The gateway is trying to resend the order following an error
Error: An error has occurred; the gateway will try to resend the order.

SupplierResponse

string (4000)

The response returned by the supplier interface when it was sent to the supplier, or the error received if a failure has occurred.

Created

date/time

The (UTC) date and time the order was created on the Gateway.

Sent

date/time

The (UTC) date and time this order was successfully sent to the supplier. 1900-01-01 00:00:00 for orders not yet sent.

BuyerAbn

string (50)

The ABN for the store that sent the order.

BillToAccountNumber

string (50)

The supplier allocated account number that identifies the account to which the financial liability will be attached.

DeliveryAccountNumber

string (50)

The supplier allocated account number that identifies the pharmacy to which the goods should be delivered.

Reference

string (50)

POS reference for this order.

SupplierId

int

The unique PharmX ID for the supplier company receiving the order (e.g, API Australia has SupplierId = 5)

StateSupplierId

int

The PharmX ID for the supplier where the supplier is sub-divided into states (e.g. , API NSW has StateSupplierId = 1107)

LineCount

int

The number of purchase order lines in the order ack, used for client validation upon receipt of the order ack.

DocumentMode

int

Defines if the order ack contains header only information or full lines information. The field can take two values:

1. Zero (0), the order ack will contain header only information and is used for status updates (ListNewOrderAcks)

1. One (1), a full order ack with order ack lines (GetOrderAck)

Lines

OrderAcknowledgementLine (array)

Will be empty where DocumentMode = 0

InterfaceVersion

If the value is 3 then assume Gateway 3.0 messaging standards.

ExtendedInfos

An array of ExtendedInfo

Field

Type

Description

OrderLineUID

guid

Set by POS as a unique reference (unique within this order only) for each order line in the order. The intention is to provide supply chain participants developers with an additional reference point assisting with integrity checking and reconciliation of order lines against return messages.

ReorderNumber

string (20)

The supplier product code for the item (PDE code).

EAN

string (50)

The EAN/GTIN code for the product.

Description

string (80)

The description of the product.

QuantityOrdered

int

The quantity of items ordered.

QuantityBackordered

int

The quantity of items backordered.

QuantityOutOfStock

int

The quantity of items out-of-stock.

UOM

string (10)

The Unit of measure, currently defined values are:
EA          Each
CT          Carton
PF          Pallet (Lift)

Default will be EA (each’s) if not provided by the supplier. This defines what is meant by a supply unit of “1”.

UnitCostexGST

decimal

The unit cost of the item ex GST.

ETA

date/time

The (UTC) date and time the order line is expected to be delivered.

Warehouse

string (50)

The supplier reference to the warehouse to which this applies.

WarehouseRole

string (50)

Whether primary or secondary warehouse (an indicator to the POS user regarding expected delivery date).

Message

string (120)

Any message accompanying the line.