Skip to main content
POST
Submit against a requirement

Authorizations

Authorization
string
header
required

JWT token for an authenticated seller session (seller_api audience)

Headers

X-Spree-Seller-Id
string
required

Path Parameters

requirement_id
string
required

Requirement ID, as returned by GET /api/v3/seller/onboarding

Body

application/json
note
string

Anything the seller wants to say alongside the submission

reference
string

A reference number or external identifier, for requirements that ask for one

file
string

A direct-upload signed_id, for requirements that ask for a document

Response

submission recorded

id
string
required
status
required

The values listed are the built-in ones; extensions may add more.

Available options:
pending,
accepted,
rejected,
waived
note
string | null
required
review_note
string | null
required
reference
string | null
required
reviewed_at
string | null
required
created_at
string
required
updated_at
string
required
file_url
string | null
required
file_name
string | null
required