{"info":{"_postman_id":"0c192eaa-f5b7-4914-b851-869946b89f6b","name":"SuperReceipt","description":"

The SuperReceipt API provides structured data from sales receipts printed on Star-Micronics thermal receipt printers. Only integrate this very simple API to obtain receipt data from virtually any POS!

How does it work?

Star-Micronics receipt printers upload an image of each printed sales receipt to the Star Cloud. When a retailer enables the 'Sophatar Data Access' service in the Star marketplace at http://www.starmicronicscloud.com, then Sophatar can access these images. We run optical character recognition (OCR) and parsing on your receipts and store the receipt data that you can query via this API.

More info?

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8158119","collectionId":"0c192eaa-f5b7-4914-b851-869946b89f6b","publishedId":"SVfMRpdq","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"E84C3D"},"publishDate":"2019-08-26T16:49:39.000Z"},"item":[{"name":"1. Retailers","item":[{"name":"List retailers","event":[{"listen":"test","script":{"id":"c812cfcc-bbb5-451b-8611-dc9fd0227fba","exec":["const Ajv = require('ajv');","const ajv = new Ajv({logger: console});","","const schema = {"," properties : {"," status : {"," type : \"string\""," },"," msg : {"," type : \"string\""," },"," retailers : {"," type : \"array\","," items : {"," type : \"object\","," required : ["," \"name\", \"picture_url\",\"thumbnail_url\",\"country\", \"state\", \"city\", \"timezone\", \"longitude\", \"latitude\", \"address_line_1\", \"address_line_2\", \"postal_code\", \"business_category\", \"business_subcategory\", \"email_address\", \"user_id\", \"location_id\""," ],"," properties : {"," name : { "," type : \"string\" "," },"," picture_url : {"," type : [\"string\",\"null\"]"," },"," thumbnail_url : {"," type : [\"string\",\"null\"]"," },"," country : {"," type : \"string\""," },"," state : {"," type : \"string\""," },"," city : {"," type : \"string\""," },"," timezone : {"," type : \"string\""," },"," longitude : {"," type : \"string\""," },"," latitude : {"," type : \"string\""," },"," address_line_1 : {"," type : \"string\""," },"," address_line_2 : {"," type : \"string\""," },"," postal_code : {"," type : \"string\""," },"," business_category : {"," type : \"string\""," },"," business_subcategory : {"," type : \"string\""," },"," email_address : {"," type : \"string\""," },"," user_id : {"," type : \"string\""," },"," location_id : {"," type : \"string\""," }"," },"," additionalProperties : false"," }"," }"," "," },"," additionalProperties : false","};","","const jsonResp = pm.response.json();","","pm.test(\"HTTP200 response\", function () {"," pm.response.to.have.status(200);","});","","pm.test('Schema is valid', function() {"," pm.expect(ajv.validate(schema, jsonResp)).to.be.true;","});","","pm.test('response status is ok', function() {"," pm.response.to.be.json;"," pm.expect(jsonResp.status).to.eql('success');"," pm.expect(jsonResp.msg).to.eql('ok');","});"," "," "," "," "],"type":"text/javascript"}}],"id":"76bc757f-16a0-41a4-a685-61c86763c3a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"apikey","value":"{{apikey}}","type":"text"}],"url":"https://api.sophatar.com/superreceipt/v1/smcs/retailers","description":"

Lists all retailers whose sales receipt data is available under your API account.\nEach retail location is determined by a unique (user_id, location_id) pair so this endpoint allows you to gather these variables together with other retailer data, such as name, physical address, email address and GPS location. The retailer data is based on what the retailer has entered in their Star Cloud account.
This is a simple GET request with no parameters required besides your apikey.

user_id is the unique Sophatar user ID of the retailer
location_id is the unique Sophatar location ID of the retailer's place of business. One or more location_ids can be associated with a single user_id

\n","urlObject":{"path":["smcs","retailers"],"host":["https://api.sophatar.com/superreceipt/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"76bc757f-16a0-41a4-a685-61c86763c3a7"}],"id":"4cfc4a3d-c3a8-49c4-ada5-e8eeef0a30bf","description":"

Use the single route in this folder to query all retailers that are available under your API acount.

\n","event":[{"listen":"prerequest","script":{"id":"c38e6ef0-a2c4-4fd2-af16-4c45a002746a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7257918f-389d-4162-9c17-323c07bd3fd2","type":"text/javascript","exec":[""]}}],"_postman_id":"4cfc4a3d-c3a8-49c4-ada5-e8eeef0a30bf","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{apikey}}"}]},"isInherited":true,"source":{"_postman_id":"0c192eaa-f5b7-4914-b851-869946b89f6b","id":"0c192eaa-f5b7-4914-b851-869946b89f6b","name":"SuperReceipt","type":"collection"}}},{"name":"2. Sales data","item":[{"name":"Query a retailer's sales data","event":[{"listen":"prerequest","script":{"id":"18cc37c7-d8a0-4e9b-8b89-14fdbfbedf91","exec":["","const flag_discount = pm.environment.get('flag_discount');","const flag_duplicate = pm.environment.get('flag_duplicate');","const flag_valid = pm.environment.get('flag_valid');","const printed_start = pm.environment.get('printed_start');","const printed_stop = pm.environment.get('printed_stop');","const processed_start = pm.environment.get('processed_start');","const processed_stop = pm.environment.get('processed_stop');","const uploaded_start = pm.environment.get('uploaded_start');","const uploaded_stop = pm.environment.get('uploaded_stop');","","const req_body = {};","","// we include or not include individual filters based on whether corresponding environment variables are specified ","// Note that the flag_xxx variables are booleans; all others are strings","if (typeof flag_discount === 'boolean') req_body['flag_discount'] = flag_discount;","if (typeof flag_duplicate === 'boolean') req_body['flag_duplicate'] = flag_duplicate;","if (typeof flag_valid === 'boolean') req_body['flag_valid'] = flag_valid;","if (typeof printed_start === 'string' && printed_start.length) req_body['printed_start'] = printed_start;","if (typeof printed_stop === 'string' && printed_stop.length) req_body['printed_stop'] = printed_stop;","if (typeof processed_start === 'string' && processed_start.length) req_body['processed_start'] = processed_start;","if (typeof processed_stop === 'string' && processed_stop.length) req_body['processed_stop'] = processed_stop;","if (typeof uploaded_start === 'string' && uploaded_start.length) req_body['uploaded_start'] = uploaded_start;","if (typeof uploaded_stop === 'string' && uploaded_stop.length) req_body['uploaded_stop'] = uploaded_stop;","","console.log(JSON.stringify(req_body));","","pm.environment.set('req_body', JSON.stringify(req_body));","",""],"type":"text/javascript"}},{"listen":"test","script":{"id":"713e59ca-12bb-43f4-b4ce-bfb8d646bf33","exec":["const Ajv = require('ajv');","const ajv = new Ajv({logger: console});","","const schema = {"," properties: {"," status: {"," type: \"string\""," },"," msg: {"," type: \"string\""," },"," limit: {"," type : \"number\""," },"," total: {"," type : \"number\""," },"," page: {"," type : \"number\""," },"," pages: {"," type : \"number\""," },"," sales_data: {"," type : \"array\","," items : {"," type : \"object\","," required : [\"receipt_id\", \"datestring_printed\", \"datestring_processed\", \"datestring_uploaded\", \"device_id\", \"employee\", \"flag_discount\", \"flag_duplicate\", \"flag_receipt\", \"flag_valid\", \"line_items\", \"location_id\", \"payment_method\", \"receipt_id_pos\", \"shipping\", \"subtotal\", \"tax1\", \"tax2\", \"total\", \"tran_type\", \"user_id\""," ],"," properties : {"," receipt_id : {"," type : \"string\""," },"," datestring_printed : {"," type : [\"string\",\"null\"]"," },"," datestring_processed : {"," type : \"string\""," },"," datestring_uploaded : {"," type : \"string\""," },"," device_id : {"," type : \"string\""," },"," employee : {"," type : \"string\""," },"," flag_discount : {"," type : \"boolean\""," },"," flag_duplicate: {"," type : \"boolean\""," },"," flag_receipt : {"," type : \"boolean\""," },"," flag_valid : {"," type : \"boolean\""," },"," line_items : {"," type : \"array\","," items : {"," type : \"object\","," required: [\"name\",\"price_total\",\"price_total_discount\",\"price_unit\",\"qty\",\"tax\"],"," properties: {"," name : {"," type : \"array\""," },"," price_total : {"," type : \"number\""," },"," price_total_discount : {"," type : \"number\""," },"," price_unit : {"," type : \"number\""," },"," qty : {"," type : \"number\""," },"," tax : {"," type : \"number\""," },"," serial_number : {"," type : \"string\""," }"," },"," additionalProperties: false"," }"," },"," location_id : {"," type : \"string\""," },"," payment_method : {"," type : \"string\""," },"," receipt_id_pos : {"," type : \"string\""," },"," shipping : {"," type : \"number\""," },"," subtotal : {"," type : \"number\""," },"," tax1 : {"," type : \"number\""," },"," tax2 : {"," type : \"number\""," },"," total : {"," type : \"number\""," },"," tran_type : {"," type : \"string\""," },"," user_id : {"," type : \"string\""," } "," },"," additionalProperties: false"," }"," }"," }, "," additionalProperties: false","};","","","const jsonResp = pm.response.json();","","pm.test(\"HTTP200 response\", function () {"," pm.response.to.have.status(200);","});","","pm.test('Schema is valid', function() {"," pm.expect(ajv.validate(schema, jsonResp)).to.be.true;","});","","pm.test('response status is ok', function() {"," pm.response.to.be.json;"," pm.expect(jsonResp.status).to.eql('success');"," pm.expect(jsonResp.msg).to.eql('ok');","});"],"type":"text/javascript"}}],"id":"77275a2f-885f-41e4-ae0f-6f52e1afa771","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"apikey","value":"{{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{{req_body}}"},"url":"https://api.sophatar.com/superreceipt/v1/smcs/sales_data/:user_id/:location_id?page={{page}}&limit={{page_size}}","description":"

This endpoint allows you to obtain sales receipt data of any retailer your API account has access to.\nSpecify the retailer by providing the (user_id, location_id) pair of this retailer, which you obtain from the List Retailers endpoint.

Data filtering

Optionally filter the receipts by including one or more filters as keys/values in the JSON request body:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

key	type	comments
flag_discount	boolean	if true / false, then only receipts that have / have no discounts are returned
flag_duplicate	boolean	if true / false, then only receipts that are / are not duplicates (re-prints) are returned. Duplicates are receipts with a POS receipt ID detected to be identical to a POS receipt ID detected on a receipt that was uploaded at an earlier time
flag_valid	boolean	if true / false, then only include receipts that are valid / invalid. We apply certain consistency checks to determine if a receipt is valid, e.g. that the sum of subtotal and tax equals the total
processed_start	ISO date/time string	earliest time when receipts were processed by Sophatar
processed_stop	ISO date/time string	latest time when receipts were processed by Sophatar
uploaded_start	ISO date/time string	earliest time when receipts were uploaded by the printer
uploaded_stop	ISO date/time string	latest time when receipts were uploaded by the printer

You can apply none, one, or more of these filters by including them in the request body. \nYou always need to specify a full date range for a query, so if you specify eg uploaded_start then you also need to specify uploaded_stop

Pagination

The response from this endpoint is paginated. By default the first page is returned. You can optionally set pagination parameters as query parameters in the request.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

query param	range & default	comments
page	1 ... {pages} (default: 1)	the page for which you want data to return. Starts from 1. {pages} is the number of pages in the request response and is present in the response header
limit	1 .. 1000 (default: 1000)	the number of returned objects per page i.e the page size

","urlObject":{"path":["smcs","sales_data",":user_id",":location_id"],"host":["https://api.sophatar.com/superreceipt/v1"],"query":[{"description":{"content":"

requested page index (index is 1-based), default: 1

\n","type":"text/plain"},"key":"page","value":"{{page}}"},{"description":{"content":"

requested page size, default: 1000, max: 1000

\n","type":"text/plain"},"key":"limit","value":"{{page_size}}"}],"variable":[{"description":{"content":"

Sophatar user ID of retailer account whose data is requested

\n","type":"text/plain"},"type":"string","value":"{{user_id}}","key":"user_id"},{"description":{"content":"

Sophatar location ID of retail rooftop location whose data is requested

\n","type":"text/plain"},"type":"string","value":"{{location_id}}","key":"location_id"}]}},"response":[],"_postman_id":"77275a2f-885f-41e4-ae0f-6f52e1afa771"}],"id":"67a9537a-dc81-4cc3-ace0-f932820775aa","description":"

Sales data from each of the retailers available under your API account

\n","event":[{"listen":"prerequest","script":{"id":"a3bb7e79-4c18-40fd-9eb2-3a163e42da21","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b6d75dab-6344-4f9f-9876-fc5f568d219c","type":"text/javascript","exec":[""]}}],"_postman_id":"67a9537a-dc81-4cc3-ace0-f932820775aa","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{apikey}}"}]},"isInherited":true,"source":{"_postman_id":"0c192eaa-f5b7-4914-b851-869946b89f6b","id":"0c192eaa-f5b7-4914-b851-869946b89f6b","name":"SuperReceipt","type":"collection"}}},{"name":"3. POS Flows","item":[{"name":"Create POS Flow - member ID scan","event":[{"listen":"test","script":{"id":"66c64f31-5e42-424e-a1a1-0cf42f2f3f4e","exec":["const {uuid} = pm.response.json();","pm.environment.set(\"uuid\", uuid);",""],"type":"text/javascript"}}],"id":"8a626369-0d4c-449c-b54d-5a3295a70b2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"apikey","value":"{{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"enable\": true,\n \"name\": \"name of this flow\",\n \"printer_code\": \"{{printer_code}}\",\n \"printer_vendor\": \"star\",\n \"triggers\": [\n {\n \"type\": \"bcrMemberIdScan\",\n \"enable\": true,\n \"params\": [\"^[\\\\d]{8}$\"]\n }\n ],\n \"actions\": [\n {\n \"type\": \"recordMemberId\",\n \"enable\": true,\n \"params\": []\n }\n ]\n }"},"url":"https://api.sophatar.com/superreceipt/v1/pos/flow/:user_id/:location_id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{apikey}}"}]},"isInherited":true,"source":{"_postman_id":"0c192eaa-f5b7-4914-b851-869946b89f6b","id":"0c192eaa-f5b7-4914-b851-869946b89f6b","name":"SuperReceipt","type":"collection"}},"urlObject":{"path":["pos","flow",":user_id",":location_id"],"host":["https://api.sophatar.com/superreceipt/v1"],"query":[],"variable":[{"type":"string","value":"","key":"user_id"},{"type":"string","value":"","key":"location_id"}]}},"response":[],"_postman_id":"8a626369-0d4c-449c-b54d-5a3295a70b2f"},{"name":"List POS Flows","id":"660f0533-254c-495e-a284-267841a612bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}","type":"text"}],"url":"https://api.sophatar.com/superreceipt/v1/pos/flow/:user_id/:location_id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{apikey}}"}]},"isInherited":true,"source":{"_postman_id":"0c192eaa-f5b7-4914-b851-869946b89f6b","id":"0c192eaa-f5b7-4914-b851-869946b89f6b","name":"SuperReceipt","type":"collection"}},"urlObject":{"path":["pos","flow",":user_id",":location_id"],"host":["https://api.sophatar.com/superreceipt/v1"],"query":[{"disabled":true,"key":"limit","value":"10"},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"printer_code","value":"{{printer_code}}"},{"disabled":true,"key":"printer_vendor","value":"star"}],"variable":[{"type":"string","value":"684b88bac1a57aa5bc82b95dd368ee91","key":"user_id"},{"type":"string","value":"5cc2af81265112376a7d","key":"location_id"}]}},"response":[],"_postman_id":"660f0533-254c-495e-a284-267841a612bb"},{"name":"Read POS Flow","id":"7b5ed9d7-9ce3-4cd7-9642-fda2127a520e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}","type":"text"}],"url":"https://api.sophatar.com/superreceipt/v1/pos/flow/:user_id:/:location_id:/:uuid","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{apikey}}"}]},"isInherited":true,"source":{"_postman_id":"0c192eaa-f5b7-4914-b851-869946b89f6b","id":"0c192eaa-f5b7-4914-b851-869946b89f6b","name":"SuperReceipt","type":"collection"}},"urlObject":{"path":["pos","flow",":user_id:",":location_id:",":uuid"],"host":["https://api.sophatar.com/superreceipt/v1"],"query":[],"variable":[{"type":"string","value":"684b88bac1a57aa5bc82b95dd368ee91","key":"user_id:"},{"type":"string","value":"5cc2af81265112376a7d","key":"location_id:"},{"type":"string","value":"4bb5cd202e9478a223c675d5c059b28b","key":"uuid"}]}},"response":[],"_postman_id":"7b5ed9d7-9ce3-4cd7-9642-fda2127a520e"},{"name":"Update POS Flow","id":"ce58ffca-18f7-46dc-bcd7-974add274c9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"apikey","value":"{{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"triggers\": [\n {\n \"enable\": true,\n \"params\": [\n \"^[\\\\d]{8}$\"\n ],\n \"type\": \"bcrMemberIdScan\"\n }\n ]\n}"},"url":"https://api.sophatar.com/superreceipt/v1/pos/flow/:user_id/:location_id/:uuid","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{apikey}}"}]},"isInherited":true,"source":{"_postman_id":"0c192eaa-f5b7-4914-b851-869946b89f6b","id":"0c192eaa-f5b7-4914-b851-869946b89f6b","name":"SuperReceipt","type":"collection"}},"urlObject":{"path":["pos","flow",":user_id",":location_id",":uuid"],"host":["https://api.sophatar.com/superreceipt/v1"],"query":[],"variable":[{"type":"string","value":"","key":"user_id"},{"type":"string","value":"","key":"location_id"},{"type":"string","value":"","key":"uuid"}]}},"response":[],"_postman_id":"ce58ffca-18f7-46dc-bcd7-974add274c9d"},{"name":"Delete POS Flow","id":"75d6bbff-b99d-42c5-80be-b4a356c9e76a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"apikey","value":"{{apikey}}","type":"text"}],"url":"https://api.sophatar.com/superreceipt/v1/pos/flow/:user_id/:location_id/:uuid","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{apikey}}"}]},"isInherited":true,"source":{"_postman_id":"0c192eaa-f5b7-4914-b851-869946b89f6b","id":"0c192eaa-f5b7-4914-b851-869946b89f6b","name":"SuperReceipt","type":"collection"}},"urlObject":{"path":["pos","flow",":user_id",":location_id",":uuid"],"host":["https://api.sophatar.com/superreceipt/v1"],"query":[],"variable":[{"type":"string","value":"","key":"user_id"},{"type":"string","value":"","key":"location_id"},{"type":"string","value":"","key":"uuid"}]}},"response":[],"_postman_id":"75d6bbff-b99d-42c5-80be-b4a356c9e76a"}],"id":"b1cd8cdf-d895-492d-96da-b1a4f5f215f2","description":"

A 'POS flow' consists of one or more triggers, and one or more actions that are executed as soon as one of the triggers of the POS flow occurs.

Currently we use a POS flow in the SuperReceipt API only to identify a barcode scan of a member ID by a barcode reader connected to a specific printer, and then trigger an action to record the embedded code.

However the concept of 'POS flows' allows us to extend this to other types of triggers, and other types of actions in the future.

For each printer where you want to scan barcodes and upload them to the SuperReceipt server, you need to create such a POS flow, and you can also set, per printer, an optional validation of the scanned code: only if validation passes is the flow executed i.e. the scan recorded in the database.

This API allows you to create, update, list, read and delete flows individualy for each of the printers, at each of the retail rooftop locations, that are under your API account.

\n","event":[{"listen":"prerequest","script":{"id":"1ade326c-34c3-4c7a-bb7c-a2b2c04b5c15","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"31884abe-9470-46d8-97d6-e9a7d5f44880","type":"text/javascript","exec":[""]}}],"_postman_id":"b1cd8cdf-d895-492d-96da-b1a4f5f215f2","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{apikey}}"}]},"isInherited":true,"source":{"_postman_id":"0c192eaa-f5b7-4914-b851-869946b89f6b","id":"0c192eaa-f5b7-4914-b851-869946b89f6b","name":"SuperReceipt","type":"collection"}}},{"name":"4. POS Scans","item":[{"name":"List POS Scans","id":"0048acab-528e-4316-8007-378f334a5f76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}","type":"text"}],"url":"https://api.sophatar.com/superreceipt/v1/pos/scan/:user_id/:location_id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{apikey}}"}]},"isInherited":true,"source":{"_postman_id":"0c192eaa-f5b7-4914-b851-869946b89f6b","id":"0c192eaa-f5b7-4914-b851-869946b89f6b","name":"SuperReceipt","type":"collection"}},"urlObject":{"path":["pos","scan",":user_id",":location_id"],"host":["https://api.sophatar.com/superreceipt/v1"],"query":[{"disabled":true,"description":{"content":"

number of scans returned per page (optional)

\n","type":"text/plain"},"key":"limit","value":"10"},{"disabled":true,"description":{"content":"

requested page (optonal)

\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"

date/time filter, start time (optional)

\n","type":"text/plain"},"key":"created_start","value":"2019-11-20T00:00:00Z"},{"disabled":true,"description":{"content":"

date/time filter, end time (optional)

\n","type":"text/plain"},"key":"created_stop","value":"2019-11-21T1:00:00Z"},{"disabled":true,"description":{"content":"

printer OEM filter (optional). Currently only 'star' is supported

\n","type":"text/plain"},"key":"printer_vendor","value":"star"},{"disabled":true,"description":{"content":"

unique printer id. For star printers, this is the printer's MAC addresss

\n","type":"text/plain"},"key":"printer_code","value":"11:11:11:11"}],"variable":[{"type":"string","value":"","key":"user_id"},{"type":"string","value":"","key":"location_id"}]}},"response":[],"_postman_id":"0048acab-528e-4316-8007-378f334a5f76"},{"name":"Read POS Scans","id":"76d34444-bbc0-4658-8cbd-99f5d374c4f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}","type":"text"}],"url":"https://api.sophatar.com/superreceipt/v1/pos/scan/:user_id/:location_id/:uuid","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{apikey}}"}]},"isInherited":true,"source":{"_postman_id":"0c192eaa-f5b7-4914-b851-869946b89f6b","id":"0c192eaa-f5b7-4914-b851-869946b89f6b","name":"SuperReceipt","type":"collection"}},"urlObject":{"path":["pos","scan",":user_id",":location_id",":uuid"],"host":["https://api.sophatar.com/superreceipt/v1"],"query":[],"variable":[{"type":"string","value":"","key":"user_id"},{"type":"string","value":"","key":"location_id"},{"type":"string","value":"","key":"uuid"}]}},"response":[],"_postman_id":"76d34444-bbc0-4658-8cbd-99f5d374c4f5"},{"name":"Delete POS Scans","id":"28bef01e-bfd9-4618-bb03-5e725cb9f3e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"apikey","value":"{{apikey}}","type":"text"}],"url":"https://api.sophatar.com/superreceipt/v1/pos/scan/:user_id/:location_id/:uuid","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{apikey}}"}]},"isInherited":true,"source":{"_postman_id":"0c192eaa-f5b7-4914-b851-869946b89f6b","id":"0c192eaa-f5b7-4914-b851-869946b89f6b","name":"SuperReceipt","type":"collection"}},"urlObject":{"path":["pos","scan",":user_id",":location_id",":uuid"],"host":["https://api.sophatar.com/superreceipt/v1"],"query":[],"variable":[{"type":"string","value":"","key":"user_id"},{"type":"string","value":"","key":"location_id"},{"type":"string","value":"","key":"uuid"}]}},"response":[],"_postman_id":"28bef01e-bfd9-4618-bb03-5e725cb9f3e3"}],"id":"1cf90c4e-061e-4997-9977-e8f3bdd06a34","description":"

POS Scans are scanned codes from a barcode reader connected to the SuperReceipt printer.\nThis allows you to capture eg. loyalty member ID codes. By correlating the timestamp of the scan with the timestamp of the receipt, you can then associate a sales receipt with a loyalty card member.

Scans are created by the printer uploading the scanned barcode to the SuperReceipt server.\nWith the routes in this folder you can list, read, and delete POS scans.

\n","event":[{"listen":"prerequest","script":{"id":"84fc124e-8433-444f-890b-9b9b7f0656f2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c5bb1188-f36b-4b73-8f88-533c9b168066","type":"text/javascript","exec":[""]}}],"_postman_id":"1cf90c4e-061e-4997-9977-e8f3bdd06a34","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{apikey}}"}]},"isInherited":true,"source":{"_postman_id":"0c192eaa-f5b7-4914-b851-869946b89f6b","id":"0c192eaa-f5b7-4914-b851-869946b89f6b","name":"SuperReceipt","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{apikey}}"}]}},"event":[{"listen":"prerequest","script":{"id":"2da1933c-efb2-4858-8cd7-384fa6ea1c1b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"32ede074-717f-43b5-bace-4d8dbce652f6","type":"text/javascript","exec":[""]}}],"variable":[{"key":"base_url","value":"https://api.sophatar.com/superreceipt/v1"}]}