Skip to main content
POST
cURL

Request Structure

Key Fields

GraphQL Product Lookups

When searching products by code or barcode via GraphQL, use the specific field filter (code, barcode, case_barcode, inner_barcode, outer_barcode) if you know which field the value belongs to. Each supports eq, ilike, in, like, and between operators. Use the all_codes filter only when you have a code/barcode value but don’t know which field it belongs to (e.g., scanning an unknown barcode). all_codes performs an exact-match OR across all 5 code fields. Do not use it when a specific field filter would suffice.

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

FlowAuthorization Code
Authorization URL
https://clarus-api.com/oauth/authorize
Token URL
https://clarus-api.com/oauth/token
FlowClient Credentials
Token URL
https://clarus-api.com/oauth/token
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Body

application/json
data
object
required

Response

Product created successfully

data
object