Request Object - PurchaseOrderAcknowledgement

Id^1*

int

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

** Required when providing an acknowledgement for an existing order.

AcknowledgedBySupplier

boolean

Not currently used. Handled by the API.

ReceivedBySupplier^1*

date/time

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

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.

SupplierUniqueMessageID

guid

Not currently used.

BuyerAbn

string (50)

Not currently used.

BillToAccountNumber²

string (50)

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

DeliveryAccountNumber^2*

string (50)

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

Reference^12*

string (50)

POS reference for this order.

** Required when sending an order created external to PharmX.

SupplierId^1*2*

int

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

StateSupplierId^1*2*

int

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

LineCount^2*

int

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

DocumentMode

int

Not currently used.

Lines^1*2*

Array of PurchaseOrderAcknowledgmentLine

An array of PurchaseOrderAcknowledgementLines.

OrderLineUID

guid

Not currently used.

ReorderNumber^1*2*

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^2*

int

The quantity of items ordered.

QuantityBackordered^1*

int

The quantity of items backordered.

QuantityOutOfStock^1*

int

The quantity of items out-of-stock.

UOM^2*

string (10)

The unit of measure. Valid 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^2*

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.