Going forward, it is recommended that all new app POS installations such as kiosks use the POS features provided by OMS v2.
The format of an app URL for use with POS is as follows:
or for distributed apps:
In the case of distributed apps, it is necessary to force the app to use product state (_usePs=1) rather than normal print jobs. This is because the print job might not be picked up by OMS for several minutes and using product state provides enough information for OMS to be able to create an order without needing the print job to be available.
An example:
Note HTTPS is required for both the main app URL and the callback URL. This means that any external assets such as stylesheets must also be specified as HTTPS.
The callback URL is specified via the ep3dUrl parameter and follows the below format:
Where k should be the API key of the relevent company.
Once the callback URL is reached, the browser will be redirected back to the original app URL after two seconds.
Note The URL will allow anybody to create an order for the company in question without any payment being made.
Note For security, it is recommended that a dedicated POS company is used that has a different API key from any relevent sites.
There are also some additional URL parameters for controlling the behaviour of the callback:
| Parameter | Values | Default | Description |
|---|---|---|---|
| k | Alpha numeric string | N/a | API key |
| r | 0 / 1 | 0 | Controls whether or not a receipt will be displayed at the end of the process |
| g | 0 / 1 | 0 | Controls whether or not to generate artwork synchronously at the end of the process |
Any ampersands (&) must be replaced with their URL safe encoding, %26.
A tool such as https://meyerweb.com/eric/tools/dencoder/ can be used to encode the entire URL.
Smart link builder will encode the URL automatically.
Normally, artwork for POS orders would join the artwork generation queue however when synchronous artwork generation is turned on, the artwork will be generated at the end of the POS process and a link provided to the end user for them to download the artwork.
There are some caveats:
Artwork cannot currently be synchronously generated if a distributed app is being used, however support may be added in the future.
Only the Node Canvas renderer is used. Output types on companies and products will be ignored.
Only the multi paged PDF output will be returned to the user.
Large products may take time to generate or generation time may be slow when the system is busy.
A receipt can be displayed at the end of the process.
The receipt contains the following information:
order-it/pos/receipt:show-item-price company setting is enabled)order-it/pos/receipt-show-product-barcode company setting is enabled)order-it/pos/receipt-show-item-barcode company setting is enabled)The format used to display the price is locale aware, with the company’s locale and currency settings being taken into account.
The price value itself is sourced from the order item’s unit sale price field.
Some apps support an order details form for collecting customer information and shipping details.
The POS callback URL can accept the following fields from an app:
customer_namecustomer_emailcustomer_telephoneshipping_address_1shipping_address_2shipping_address_3shipping_address_4shipping_address_5shipping_postcodeshipping_countryshipping_country_codebilling_customer_namebilling_customer_emailbilling_customer_telephonebilling_address_1billing_address_2billing_address_3billing_address_4billing_address_5billing_postcodebilling_countrybilling_country_codeshipping_methodshipping_carriershipping_trackingrequired_dispatch_datecoupon_code