OrderCreateLine
Type: object.
| Name | Type | Description |
|---|---|---|
productCode required | string | |
quantity required | integer | At least 1. |
notes | string | |
unitPrice | string | The price per unit (per pound with a weight), a plain decimal ("3.29"). It lands on the POS invoice line as sent and is never repriced. Optional: a line without unitPrice (omitted, or an empty string) is priced by the store when the order is dispatched, under the store's price rule (the store owner sets it in the console, per store or per integration): register, the default, charges what the store's register charges, over the whole order: the regular price, sale prices with their limits, package prices (such as 3 for $5) and package sales, case prices, mix and match groups priced together, minimum purchases, scheduled price changes and the customer's contract price (found by the order's phone); order_screen charges what the store's own Customer Orders screen charges (the item's regular price, or the customer's dollar contract price; no sale, no deal). Lines without a unitPrice for the same product are priced as one register line. A deal the register charges as a line total that is not a whole number of cents per unit is posted as the same product at two unit prices a cent apart, or, at a store that does not allow the same product twice in one order, as the product at its regular price and an adjustment line carrying the saving; storePrices shows the line total and those parts. A line with a unitPrice is never repriced; it counts toward a minimum purchase at its own price. Under register, the customer the order lands on (by its phone) also gets the percent discount the store's register gives that customer, taken off the lines the store priced (never off a line with a unitPrice, which still counts toward the customer's minimum for the discount) and posted as savings lines without a product code, one per tax class; storeDiscount shows it. order_screen gives none, like the Customer Orders screen. The store refuses to price a line, and the order parks (dispatchState parked; the dispatchError starts [INVALID_LINE] and names the line, its code and the reason; send the order again with a unitPrice on that line) when: the register would price it together with a line you priced (the same product with a quantity deal, or the same mix and match group); the item is in a buy-one-get-one group; a sale is limited per customer; the customer's contract price is a percentage (register rule); a rule the store runs while pricing may change the line and what it does cannot be proven (the reason names the rule), or a scheduled price depends on a condition; the customer's discount cannot be determined with certainty (for example it depends on the age of the customer's balance, a password prompt, or how the order is paid); the store gives discounts by loyalty points; the item is sold by weight and the line has no weight, or the register prices a weighed item with a quantity deal; the item is sold by price-embedded labels, or the code carries its own price or weight; the item is not for sale, inactive, or the register asks for its price; the price is 0; the same product is on two lines at a store that may not allow it (send one line); on the order_screen rule, the store turned off automatic prices on customer orders (POS preference #348); or the store cannot determine the product, the customer, a setting or the price with certainty. A store agent or relay that does not price lines yet parks the order unsent with [AGENT_STORE_PRICING_UNSUPPORTED] or [RELAY_STORE_PRICING_UNSUPPORTED] (a line with a weight is gated the same way); it never lands at a zero price. |
weight | string | Optional weight in pounds for an item sold by weight: a decimal string with at most three decimals, above 0 and at most 9999.999 (anything else is a free 400 before billing). The store books the weight as the line's quantity and prices it per pound: at unitPrice when you send one, else the store's price per pound. A weight is refused (the order parks with [INVALID_LINE]) when the item is not sold by weight, or when it has more decimals, or is larger, than the store's POS keeps on an invoice line (two decimals and 999.99 on current TisWin3 databases). A line for an item sold by weight that is sent without a unitPrice needs a weight. quantity stays required on every line; on a weighed line the POS books the weight, not the quantity. Pattern: ^[0-9]{1,4}(\.[0-9]{1,3})?$ |
No other fields appear.