Validate Serial Numbers

Checks that every serial number in the list exists for the variant, optionally also requiring a specific status and location. Returns an empty object when all serials are valid; returns a 400 error naming the offending serials otherwise. Useful to pre-validate serial input before submitting an adjustment, transfer or sale.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Variant id the serials belong to

Body Params

Serial validation payload

serials
array of strings

Serial numbers to validate (required)

serials
string
enum

Optionally require every serial to be in this status

Allowed:
integer

Optionally require every serial to be at this location

Headers
string
required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json