Request Object – PurchaseOrder

BuyerAbn

string (50)

The ABN for the store sending the order.

Must be string of length 13 or greater.

BillToAccountNumber

string (50)

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

Must be string of length 1 or greater.

DeliveryAccountNumber*

string (50)

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

Must be string of length 1 or greater.

Purchaser

string (50)

Identifies the purchase manager who sent the order.

PurchaserSignature

string (50)

Backup

string (50)

Default blank unless specified for supplier.

Code

string (50)

Default blank unless specified for supplier.

DeliverNoEarlierThan

date/time

The requested (UTC) date time after which the order can be delivered.

A valid (UTC) datetime > getdate()
(must be less than “DeliverNoLaterThan”).

DeliverNoLaterThan

date/time

The requested (UTC) date time before which the order can be delivered.

A valid (UTC) datetime > “DeliverNoEarlierThan”.

Group

string (50)

Default blank unless specified for supplier.

Method

string (10)

Default blank unless specified for supplier.

Reference*

string (50)

POS reference for this order. Reference must be unique. Orders with a duplicate order reference will be cancelled at the gateway.

POSuniqueMessageID

guid

A GUID, identifies the message. Must be unique for the sending system.

Cannot be an empty guid, i.e. 00000000-0000-0000-0000-000000000000.

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).

Type

string (10)

Default blank unless specified for supplier.

LineCount*

int

The number of purchase order lines in the order, used for gateway validation upon receipt of CreateOrder request.

The system will confirm LineCount = number of order lines, else CreateOrder fails.

Freight

int

Set to ‘99’ to override order compliance checks for the order (with the intention of conveying to the supplier the acceptance of additional charges should they apply), else set to zero (0).

Lines*

Array of PurchaseOrderLine

An array of PurchaseOrderLine.

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 POS developers with an additional reference point assisting with integrity checking and reconciliation of invoice lines by the POS.

Must be populated and be unique for each order line.

ReorderNumber*

string (20)

The supplier product code for the item (aka, part code, PDE code)

EAN

string (50)

The EAN/GTIN code for the product.

Must be string of length 1 or greater.

Description

string (80)

The description of the product

QuantityOrdered*

int

The quantity of items ordered

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”.

Must be one of the three UOM defined.

UnitCostexGST*

decimal

The unit cost of the item ex GST.

Must be a value of “0.00” or greater.