Response Object – Supplier
Field | Type | Description |
|---|---|---|
Active | bool | Indicates whether the supplier is active and available for use in the gateway |
Description | string (50) | Description or name of the supplier |
SupplierId | int | The unique PharmX ID for the supplier company receiving the order (e.g, API Australia has SupplierId = 5) |
StockAvailabilityRequests | bool | Whether the supplier supports stock availability requests |
SupplierAvailableRoles | Array of string (150) | A list of role names associated to the supplier. Available roles are:
|
OrderCodeDefault | string (50) | The recommended default “code” value in the order header for the supplier. An empty string implies no value is required |
OrderTypeRequired | string (50) | The recommended default “type” value in the order header for the supplier. An empty string implies no value is required |
OrderMethodRequired | string (50) | The recommended default “method” value in the order header for the supplier. An empty string implies no value is required |
OrderBackupRequired | string (50) | The recommended default “backup” value in the order header for the supplier. An empty string implies no value is required |
MaxOrdersPerMonth | int | The default maximum free deliveries per month before freights costs may become applicable. If 0, then this limit does not apply to the account |
MinimumOrderValue | decimal | The default minimum order value for this supplier. If > 0.000, the supplier has implemented order compliance with minimum order value requirements. Orders may be rejected with error code 99 for this supplier if order value does not exceed the MinimumOrderValue for the supplier and account |
FreightCosts | decimal | The default freight costs for this supplier. If > 0.000, the possible freight costs to be incurred if order value does not exceed MinimumOrderValue |
PurchaserSignatureRequired | bool | If “True”, the purchaseOrder object must contain a value for <PurchaserSignature> |
OutOfStockSupport | bool | If the supplier provides order acknowledgement or OOS feedback |
InvoiceSupport | bool | If the supplier provides invoices |
CreditSupport | bool | If the supplier provides credit notes |
InvoiceCanBeConsolidated | bool | If the supplier is known to consolidate invoices |
MOQcheckRequired | bool | If the supplier has implemented order compliance with MOQ checks |
StateSuppliers | Array of StateSupplier | An array of StateSupplier |
AlternateIDs | Array of AlternateIDs | A list of alternate identifiers for the supplier. |