Skip to main content
POST
Upload a sales report

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

multipart/form-data
file
file
required

The report: an .xlsx or .csv file, up to 25MB. Its columns must match the config's saved mapping.

report_date
string<date>

The report's own date (YYYY-MM-DD): the date its figures are stored under. Defaults to today (UTC). Re-sending a report for the same date replaces its figures.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

Response

202 - application/json

Default Response

uuid
string
required
config_uuid
string
required
source
enum<string>
required
Available options:
upload,
email,
portal,
api
status
enum<string>
required

queued, then processing, then completed or failed.

Available options:
queued,
processing,
completed,
failed
report_date
string
required

YYYY-MM-DD

file_name
string | null
required
rows_total
number
required
rows_skipped
number
required
rows_failed
number
required
partners_matched
number
required
partners_unmatched
number
required
partners_ignored
number
required
partners_ambiguous
number
required
lines_matched
number
required
lines_unmatched
number
required
error
object | null
required

Set when the whole import failed.

created_at
string
required
processed_at
string | null
required