List Receipt Submissions

Request

Query Params

states[]

array[string] | null

optional

Allow filtering submissions by states

store_ids[]

array[string]

optional

Allow filtering submissions by store_ids

ids[]

string

optional

Allow filtering submissions by ids

from

string <date-time>

optional

Allow filtering submissions by date, Start date/time for filtering results. Must be in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ)

string <date-time>

optional

Allow filtering submissions by date, End date/time for filtering results. Must be in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ) and greater than the 'from' parameter

per_page

integer

optional

Number of results to be returned per request. See: API Pagination

page_no

integer

optional

Number of results page. See: API Pagination

>= 1

Default:

sort_by[]

string

optional

See: Sorting params

Default:

sort_directions[]

enum<string>

optional

See: Sorting params

Allowed values:

ASCDESC

Default:

DESC

Examples:

ASCDESC

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

submissions

array [object {12}]

required

Total number of not seen Notifications

integer

optional

member_id

integer

optional

state

enum<string>

optional

Allowed values:

draftpendingrejectedacceptedmanual_verification

error_messages

array[string]

optional

Errors encuntered during automatic OCR processing

rejection_reasons

array[string]

optional

manual_verification_reasons

array[string]

optional

suspected_duplicates

array[integer]

optional

file

object (File) | null

read-onlyoptional

form

object (Receipt Submission Form)

optional

prefilled_form

object (Receipt Submission Form)

optional

created_at

string <date-time>

read-onlyoptional

Time of record creation

Example:

2022-11-05T16:25:58.099512Z

updated_at

string <date-time>

read-onlyoptional

Time of the last record update

Example:

2022-11-15T16:25:58.099512Z

pagination_info

object (PaginationInfo) | null

read-onlyrequired

count

integer

read-onlyrequired

Actual number of results returned in request

Example:

1000

total_count

integer

required

Number of all available results

>= 1

Example:

2050

per_page

integer

read-onlyrequired

Number of results returned per request

Example:

1000

total_pages

integer

read-onlyrequired

Number of all available pages

Example:

current_page

integer

read-onlyrequired

Example:

next_page

integer | null

read-onlyrequired

Next available page (null when it's a last page)

Example:

prev_page

integer | null

read-onlyrequired

Next available page (null when it's a first page)

Example:

null

is_first_page

boolean

read-onlyrequired

Example:

true

is_last_page

boolean

read-onlyrequired

Example:

false

is_out_of_range

boolean

read-onlyrequired

Is given per_page param out of range?

Example:

false

offset

integer

read-onlyrequired

Example:

Example

{
  "submissions": [
    {
      "id": 0,
      "member_id": 0,
      "state": "draft",
      "error_messages": [
        "string"
      ],
      "rejection_reasons": [
        "string"
      ],
      "manual_verification_reasons": [
        "string"
      ],
      "suspected_duplicates": [
        0
      ],
      "file": {
        "url": "https://example.com/image.png",
        "identifier": "1",
        "mime_type": "image/jpeg",
        "created_at": "2022-11-09T15:46:00.252860Z",
        "updated_at": "2022-11-09T15:46:00.252860Z",
        "image_details": {
          "width": 1,
          "height": 1
        }
      },
      "form": {
        "store_id": 0,
        "transaction_date": "2023-01-15",
        "total_amount": 0
      },
      "prefilled_form": {
        "store_id": 0,
        "transaction_date": "2023-01-15",
        "total_amount": 0
      },
      "created_at": "2022-11-05T16:25:58.099512Z",
      "updated_at": "2022-11-15T16:25:58.099512Z"
    }
  ],
  "pagination_info": {
    "count": 1000,
    "total_count": 2050,
    "per_page": 1000,
    "total_pages": 3,
    "current_page": 1,
    "next_page": 2,
    "prev_page": null,
    "is_first_page": true,
    "is_last_page": false,
    "is_out_of_range": false,
    "offset": 0
  }
}