Download OpenAPI specification:Download
Fetches at most 10 processed receipts per invocation.
Invoke at most once every 10 seconds.
X-Api-Key | string API Key |
handle-id | string (Ourcart receipt ID) |
object (Sent receipt image(s)) Information about the receipt in its original content type | |
object (Receipt) The receipt portion of receipt data | |
object (Flaws) A map of warning flags which may require the client's attention | |
object (Error) At least one step in the processing flow did not complete successfully | |
requested-on | string <date-time> (The timestamp on which sent receipt image(s) were submitted) |
consumed-on | string <date-time> (The timestamp on which sent receipt image(s) started processing) |
completed-on | string <date-time> (The timestamp on which sent receipt image(s) completed processing resulting in receipt data) |
attempted-transcription-method | string (The attempted transcription method) Value: "AUTOMATIC, MANUALLY_ENHANCED" AUTOMATIC if receipt was processed in a fully automatic way; MANUALLY_ENHANCED if receipt processing was enhanced by manual human intervention. |
{- "handle-id": "string",
- "capture": {
- "client-code": "string",
- "client-handle-id": "string",
- "client-user-id": "string",
- "country": "string",
- "transcription-method": "AUTOMATIC, or MANUALLY_ENHANCED",
- "snapshots": [
], - "products-of-interest": [
- {
- "gtin": "string",
- "title": "string",
- "brand": "string"
}
], - "callback": {
- "url": "string",
- "auth": "string",
- "auth-type": "AUTHORIZATION"
}, - "pre-callback": {
- "url": "string",
- "auth": "string",
- "auth-type": "AUTHORIZATION"
}
}, - "receipt": {
- "retailer-name": "string",
- "retailer-display-name": "string",
- "retailer-type": "string",
- "address": "string",
- "store": {
- "street": "string",
- "street-num": "string",
- "city": "string",
- "zip": "string",
- "state": "string"
}, - "purchase-date": "string",
- "purchase-time": "string",
- "total": {
- "amount": 0,
- "currency": "string"
}, - "discounts": {
- "text": "string",
- "total": 0
}, - "items": [
- {
- "code": "string",
- "text": "string",
- "total": {
- "amount": 0,
- "currency": "string"
}, - "price": {
- "amount": 0,
- "currency": "string"
}, - "quantity": {
- "value": 0,
- "unit": "string"
}, - "product-of-interest": true,
- "product": {
- "gtin": "string",
- "sku": "string",
- "title": "string",
- "brand": "string",
- "price": {
- "amount": 0,
- "currency": "string"
}, - "category": "string",
- "package-size": "string",
- "taxonomy-categories": [
- {
- "title": "string",
- "code": "string",
- "level": 0,
- "taxonomy-name": "string"
}
], - "confidence": 0.1
}, - "type": "item, discount"
}
], - "phone": "string",
- "payment-method": "string",
- "receipt-num": "string"
}, - "flaws": {
- "codes": {
- "property1": "string",
- "property2": "string"
}
}, - "error": {
- "worker-name": "string",
- "message": "string"
}, - "requested-on": "2019-08-24T14:15:22Z",
- "consumed-on": "2019-08-24T14:15:22Z",
- "completed-on": "2019-08-24T14:15:22Z",
- "attempted-transcription-method": "AUTOMATIC, MANUALLY_ENHANCED"
}
Sends receipt image(s) for data extraction
X-Api-Key | string API Key |
client-code required | string (Client Code) |
client-handle-id | string (Receipt ID assigned by client) |
client-user-id | string (End user ID assigned by client) |
country required | string (Country Code in Alpha-2 format) |
transcription-method required | string (Transcription Method) Value: "AUTOMATIC, or MANUALLY_ENHANCED" Choose MANUALLY_ENHANCED if you want receipt to be processed by human being as well, in case automatic transcription doesn't give good enough results |
required | Array of objects (A list of Snapshot URLs, maximum 4) |
Array of objects (A list of products which the client is interested in identifying on the receipt) | |
object (Callback upon receipt processing) Callback to be performed upon receipt processing. | |
object (Callback upon receipt processing) Callback to be performed upon receipt processing. |
{- "client-code": "string",
- "client-handle-id": "string",
- "client-user-id": "string",
- "country": "string",
- "transcription-method": "AUTOMATIC, or MANUALLY_ENHANCED",
- "snapshots": [
], - "products-of-interest": [
- {
- "gtin": "string",
- "title": "string",
- "brand": "string"
}
], - "callback": {
- "url": "string",
- "auth": "string",
- "auth-type": "AUTHORIZATION"
}, - "pre-callback": {
- "url": "string",
- "auth": "string",
- "auth-type": "AUTHORIZATION"
}
}
Checks current processing status of an individual receipt.
client-handle-id required | string |
X-Api-Key | string API Key |
client-handle-id | string (Client handle ID) |
timestamp | string <date-time> (The timestamp of latest status change) |
status | string (Current receipt processing status) |
object (Map of flaws) |
error | string (Error type) |
error-message | string (Error message) |
{- "client-handle-id": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "status": "string",
- "flaws": {
- "property1": "string",
- "property2": "string"
}
}
Retrieves all health check data from DynamoDB as a map.
functionality | string (Functionality name) |
description | string (Functionality description) |
status | string (Health status) |
timestamp | string (Timestamp of the health check) |
{- "functionality": "string",
- "description": "string",
- "status": "string",
- "timestamp": "string"
}