Goto: eLink Home | Purchase Order Line
This packet holds information about a product sold, or being purchased. It differs from a product definition in that this packet holds item specific information, such as price used or serial number.
Several APIs use this structure but not all fields apply to all API calls.
| Arg# | Binary | Description | ||||||||||||||||||||||||||||||||||||
| 200 | 'E' | Required. Product id for the product being sold.
If this saleline is a modifier (rare) this field contains the Modifier id#. If product ids are not being used (and this is very special case) then the Global Product Id field (f212) must be supplied | ||||||||||||||||||||||||||||||||||||
| 201 | 'E' | NYI. Product variant id for the product being sold | ||||||||||||||||||||||||||||||||||||
| 202 | 'E' | Quantity of product being sold. If not specified the value is assumed to be 1 (one). The quantity field is an integer (not a fractional number) in the measurement units of the product. Most items are unit based (a bar of chocolate), but others are weight or volume based ("flour"). If the item is measured in grams, then this field contains the number of grams. Use caution, as prices are typically in a different measurement, such as $ per Kilogram. | ||||||||||||||||||||||||||||||||||||
| 203 | 'E' | Pidflag for the product being sold, which indicates the type of product id in f200. All normal products (those listed in retailmax.elink.products) use PidFlag=0, which is the default if not supplied. A value of "5" is used for Product Modifiers. | ||||||||||||||||||||||||||||||||||||
| 205 | 's' | Required. Total price including all taxes where possible. | ||||||||||||||||||||||||||||||||||||
| 206 | 'E' | Optional line sequence (ordinal position). If supplied, must be a positive integer. | ||||||||||||||||||||||||||||||||||||
| 207 | 's' | Optional. Part Code, or PLU code to be selected. Commonly used on an inbound purchase order where Pid (f200) is unknown. | ||||||||||||||||||||||||||||||||||||
| 208 | 's' | Optional. Barcode of item to be selected. (format, symbology TBS) | ||||||||||||||||||||||||||||||||||||
| 209 | 's' | Optional. Serial number of item | ||||||||||||||||||||||||||||||||||||
| 210 | 'E' | Optional/Rare. Prepay card account number. Special usage only | ||||||||||||||||||||||||||||||||||||
| 211 | 's' | Optional. Registration number of a Vehicle. Is ONLY used to hold motor vehicle registrations | ||||||||||||||||||||||||||||||||||||
| 212 | 's' | Optional/Mandatory. Global Product Id. A controlled numbering scheme where every product is allocated a unique number/letter sequence, but the scheme allows independent creation of new id values. If you use this field, values must conform to the allocation standard. | ||||||||||||||||||||||||||||||||||||
| 213 | 'E' | Unit of measure for f202 (Qty).
| ||||||||||||||||||||||||||||||||||||
| 303 | 's' | Total value of line, including all taxes. This value should equal f304 + f305 + f306 + f307. If a sale contains a mix of taxable and non-taxable items, these fields must be present on all packets. | ||||||||||||||||||||||||||||||||||||
| 304 | 's' | Total value of line, excluding all taxes | ||||||||||||||||||||||||||||||||||||
| 305 | 's' | Total of tax #1 (GST in New Zealand, Australia, Zimbabwe. MwSt in Germany. VAT in United Kingdom) | ||||||||||||||||||||||||||||||||||||
| 306 | 's' | Total of tax #2 | ||||||||||||||||||||||||||||||||||||
| 307 | 's' | Total of tax #3 | ||||||||||||||||||||||||||||||||||||
| 308 | 's' | Tax Control information | ||||||||||||||||||||||||||||||||||||
| 320 | 's' | Optional. Unit price of item used for price calculations. | ||||||||||||||||||||||||||||||||||||
| 340 | 's' | Optional. SVC Account number. Required if product references Prepay topup | ||||||||||||||||||||||||||||||||||||
| 400 | 'E' | Optional. Fuel Dispenser used for this item. | ||||||||||||||||||||||||||||||||||||
| 401 | 's' | Optional. Serial Number of item. The quantity of this line is expected to be "1" as only one serial number can be stored per line | ||||||||||||||||||||||||||||||||||||
| 410 | 'E' | Optional/Rare. Picked by Teller Id. (Not typically supplied when storing sales as servers allocate these values as items processed) | ||||||||||||||||||||||||||||||||||||
| 411 | 'E' | Optional/Rare. Picked Qty. (Not typically supplied when storing sales as servers allocate these values as items processed) | ||||||||||||||||||||||||||||||||||||
| 412 | 's' | Optional/Rare. Picked total price. (Not typically supplied when storing sales as servers allocate these values as items processed) | ||||||||||||||||||||||||||||||||||||
| 420 | 's' | Optional/Rare. OCR Item Description. Where a line has been created in reference to an OCR document, this line can be used to return the original OCR line that was used to select the product. | ||||||||||||||||||||||||||||||||||||
| 421 | 's' | Customers order number. This is used on salelines only to record the customers orderno. | ||||||||||||||||||||||||||||||||||||
| 500 | 's' | Tracked Item Reference #. A key that references a single tracked item | ||||||||||||||||||||||||||||||||||||
| 501 | 's' | Physkey ref. A key referencing another object. Valid only in certain circumstances | ||||||||||||||||||||||||||||||||||||
Purchase Order Lines
These fields are used to hold information that is unique to a purchase order, and will not be found on salelines
| Arg# | Binary | Description |
| 1000 | 'E' | |
| 1001 | 's' | Supplier Part Code to order |
| 1002 | 'e' | Quantity of f1001 (Supplier Part Code) to order. This is the number of outers, not total units. So if the supplier part code "ABC-5" is an outer of 5 units, and you wish to order 2 boxes to get a total of 10 units, this field would contain "2". |
Extended information
These fields are sometimes present when representing a sale, but are not directly required. For example, a field here holds the description of the product, when the pid field (f200) holds a pointer to the product anyway. These fields are useful when sending a sale to another system, as this additional information can save extra network trips.
| Arg# | Binary | Description |
| 2000 | 's' | Product Description |
| 2001 | 's' | Product PLU |