Start Upload - Placewise API

Request

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:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Body Params application/json

file_type

string

required

Type of file being uploaded

Example:

receipt_submission

mime_type

enum<string>

required

File's mime type

Allowed values:

storecinemadiningoffice

Default:

store

Example:

image/jpeg

size

integer

required

Size of file being uploaded in bytes

> 0

Example:

1000

file_name

string | null

optional

Optional name of file. It will be visible when downloading the file. If not provided it will be auto generated.

Example:

my-file.jpeg

file_identifier

string | null

optional

File is attached to identifier. Identifier can be: auto-generated UUID or a string which identifies resource to which file will be attached. See general documentation to find out more.

Example:

file_sub_identifier

string | null

optional

When single identifier can have more than 1 file attached (e.g. article's attachments) then this field is used to identify single file record.

Example

{
  "file_type": "receipt_submission",
  "mime_type": "store",
  "size": 1000,
  "file_name": "my-file.jpeg",
  "file_identifier": "42",
  "file_sub_identifier": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

file_handle

string

required

Handle of file which can be used to continue the upload

file_record

object (FileRecord)

required

integer

required

type

string

required

identifier

string | null

required

sub_identifier

string | null

optional

customer_id

integer | null

required

loyalty_club_id

integer | null

required

user_id

string | null

required

url

null

required

filename

string | null

required

mime_type

string

required

size

integer

required

created_at

string

required

updated_at

string

required

active

boolean

required

last_active_at

null

required

duplicated_from_file_record_id

null

required

Example

{
  "file_handle": "string",
  "file_record": {
    "id": 0,
    "type": "string",
    "identifier": "string",
    "sub_identifier": "string",
    "customer_id": 0,
    "loyalty_club_id": 0,
    "user_id": "string",
    "url": null,
    "filename": "string",
    "mime_type": "string",
    "size": 0,
    "created_at": "string",
    "updated_at": "string",
    "active": true,
    "last_active_at": null,
    "duplicated_from_file_record_id": null
  }
}