Products

List products

Scopes

• products:read

Parameters

• cursorquerystring
• limitqueryinteger
• qquerystringFull-text search on names and titles.

Responses

• 200OK
  ProductPageFields (2)

  • dataarray of ProductRequired
  • next_cursorstring | nullRequiredPass as cursor for the next page; null on the last page.
• 401Missing, revoked, or expired API key.
• 403The key lacks the scope.
• 429Rate limited: 60 requests per minute per key.

Create

Scopes

• products:write

Parameters

• Idempotency-KeyheaderstringRequiredStored 24 h per company and key. Same key with a different body returns 422.

Request body

Responses

• 201Created
  ProductFields (11)

  • idstring
  • versionintegerIncrements on every write. Send it back in If-Match.
  • created_atstring (date-time)
  • updated_atstring (date-time)
  • deleted_atstring | null
  • external_idstring | nullYour system's id, unique per company.
  • namestringRequired
  • brand_namestring | null
  • product_codestring | null
  • descriptionstring | null
  • supplier_idstring | null
• 400Validation failed.
• 409Version conflict, external_id taken, or a secret that cannot be replayed.
• 422Semantically invalid, or an Idempotency-Key reused with a different body.
• 401Missing, revoked, or expired API key.
• 403The key lacks the scope.
• 429Rate limited: 60 requests per minute per key.

Get

Scopes

• products:read

Parameters

• idpathstringRequired

Responses

• 200OK
  ProductFields (11)

  • idstring
  • versionintegerIncrements on every write. Send it back in If-Match.
  • created_atstring (date-time)
  • updated_atstring (date-time)
  • deleted_atstring | null
  • external_idstring | nullYour system's id, unique per company.
  • namestringRequired
  • brand_namestring | null
  • product_codestring | null
  • descriptionstring | null
  • supplier_idstring | null
• 404Not found. Records of other companies are also reported as not found.
• 401Missing, revoked, or expired API key.
• 403The key lacks the scope.
• 429Rate limited: 60 requests per minute per key.

Update (partial)

Scopes

• products:write

Parameters

• idpathstringRequired
• Idempotency-Keyheaderstring
• If-MatchheaderintegerThe version you last read; 409 version_conflict when it changed.

Request body

Responses

• 200OK
  ProductFields (11)

  • idstring
  • versionintegerIncrements on every write. Send it back in If-Match.
  • created_atstring (date-time)
  • updated_atstring (date-time)
  • deleted_atstring | null
  • external_idstring | nullYour system's id, unique per company.
  • namestringRequired
  • brand_namestring | null
  • product_codestring | null
  • descriptionstring | null
  • supplier_idstring | null
• 400Validation failed.
• 404Not found. Records of other companies are also reported as not found.
• 409Version conflict, external_id taken, or a secret that cannot be replayed.
• 422Semantically invalid, or an Idempotency-Key reused with a different body.
• 401Missing, revoked, or expired API key.
• 403The key lacks the scope.
• 429Rate limited: 60 requests per minute per key.

Delete (soft; restorable for 30 days)

Scopes

• products:write

Parameters

• idpathstringRequired
• Idempotency-Keyheaderstring

Responses

• 204Deleted
• 404Not found. Records of other companies are also reported as not found.
• 401Missing, revoked, or expired API key.
• 403The key lacks the scope.
• 429Rate limited: 60 requests per minute per key.

Restore within 30 days of deletion

Scopes

• products:write

Parameters

• idpathstringRequired
• Idempotency-Keyheaderstring

Responses

• 200OK
  ProductFields (11)

  • idstring
  • versionintegerIncrements on every write. Send it back in If-Match.
  • created_atstring (date-time)
  • updated_atstring (date-time)
  • deleted_atstring | null
  • external_idstring | nullYour system's id, unique per company.
  • namestringRequired
  • brand_namestring | null
  • product_codestring | null
  • descriptionstring | null
  • supplier_idstring | null
• 404Not found. Records of other companies are also reported as not found.
• 401Missing, revoked, or expired API key.
• 403The key lacks the scope.
• 429Rate limited: 60 requests per minute per key.

Create or replace by your external id

Scopes

• products:write

Parameters

• external_idpathstringRequired
• Idempotency-Keyheaderstring
• If-MatchheaderintegerThe version you last read; 409 version_conflict when it changed.

Request body

Responses

• 200Updated
  ProductFields (11)

  • idstring
  • versionintegerIncrements on every write. Send it back in If-Match.
  • created_atstring (date-time)
  • updated_atstring (date-time)
  • deleted_atstring | null
  • external_idstring | nullYour system's id, unique per company.
  • namestringRequired
  • brand_namestring | null
  • product_codestring | null
  • descriptionstring | null
  • supplier_idstring | null
• 201Created
  ProductFields (11)

  • idstring
  • versionintegerIncrements on every write. Send it back in If-Match.
  • created_atstring (date-time)
  • updated_atstring (date-time)
  • deleted_atstring | null
  • external_idstring | nullYour system's id, unique per company.
  • namestringRequired
  • brand_namestring | null
  • product_codestring | null
  • descriptionstring | null
  • supplier_idstring | null
• 400Validation failed.
• 409Version conflict, external_id taken, or a secret that cannot be replayed.
• 422Semantically invalid, or an Idempotency-Key reused with a different body.
• 401Missing, revoked, or expired API key.
• 403The key lacks the scope.
• 429Rate limited: 60 requests per minute per key.