Show Receipt Submission - Placewise API

Request

Path Params

submission_id

string

required

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

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.mpc.dev.placewise.com/v1/receipts/submissions/' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'Authorization;' \
--header 'X-Client-Authorization: '

Responses

🟢200Success

application/json

Body

id

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

url

string <uri>

read-onlyrequired

Example:

https://example.com/image.png

identifier

string

optional

Only present when parent record has many files

Example:

1

mime_type

string | null

read-onlyoptional

Only present in certain circumstances

Example:

image/jpeg

created_at

string <date-time>

required

Example:

2022-11-09T15:46:00.252860Z

updated_at

string <date-time>

read-onlyrequired

Example:

2022-11-09T15:46:00.252860Z

image_details

object | null

optional

form

object (Receipt Submission Form)

optional

store_id

integer

optional

ID of store

transaction_date

string <date>

optional

Example:

2023-01-15

total_amount

integer

optional

Amount on receipt as string

prefilled_form

object (Receipt Submission Form)

optional

verified_by

object

optional

id

string

optional

first_name

string

optional

last_name

string

optional

comment

string

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

Example

{
    "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
    },
    "verified_by": {
        "id": "string",
        "first_name": "string",
        "last_name": "string"
    },
    "comment": "string",
    "created_at": "2022-11-05T16:25:58.099512Z",
    "updated_at": "2022-11-15T16:25:58.099512Z"
}