API reference

Categories & brands

Read the store's categories and brands (to use their ids on products).

On this page

List categories
List brands

get/categories

Required scopes:read_products

Query parameters

Name	Type	Description
`limit`	integer	Page size, 1–250 (default 50). default 50 · min 1 · max 250
`cursor`	string	next_cursor from the previous page.
`updated_since`	string<date-time>	Only objects changed at or after this ISO-8601 time.
`created_since`	string<date-time>	Only objects created at or after this ISO-8601 time.
`parent_id`	integer	Children of this category.

Example request

curl

curl "https://api.sellorchard.com/v1/categories?limit=50" \
  -H "Authorization: Bearer $SELLORCHARD_API_KEY"

Response200Categories.

Show response schema

dataarray of Categoryrequired
ShowHide item attributes
- objectstringrequired
- idintegerrequired
  Id.
- namestringrequired
  Name.
- slugstringrequired
  URL handle.
- parent_idinteger | nullrequired
  Parent category.
- descriptionstring | nullrequired
  Description.
- is_visiblebooleanrequired
  Shown on the storefront.
- positionintegerrequired
  Order.
- created_atstring<date-time> | nullrequired
  Created.
- updated_atstring<date-time> | nullrequired
  Last changed.
has_morebooleanrequired
More pages after this one.
next_cursorstring | nullrequired
Pass as cursor for the next page; null on the last page.

200 response

{
  "data": [
    {
      "object": "category",
      "id": 7,
      "name": "Tops",
      "slug": "tops",
      "parent_id": null,
      "description": null,
      "is_visible": true,
      "position": 0,
      "created_at": "2026-11-02T15:00:00Z",
      "updated_at": "2026-11-03T09:30:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Error responses

400invalid_requestMalformed request (e.g. a bad cursor).
401authenticationMissing, invalid, expired or revoked API key.
403permissionThe key lacks the scope, or the store's plan doesn't include the API.
422invalid_requestInvalid parameters; errors lists each field.
429rate_limitedToo many requests.
500serverSomething went wrong on our side; safe to retry with the same Idempotency-Key.

List brands

get/brands

Required scopes:read_products

Query parameters

Name	Type	Description
`limit`	integer	Page size, 1–250 (default 50). default 50 · min 1 · max 250
`cursor`	string	next_cursor from the previous page.
`updated_since`	string<date-time>	Only objects changed at or after this ISO-8601 time.
`created_since`	string<date-time>	Only objects created at or after this ISO-8601 time.

Example request

curl

curl "https://api.sellorchard.com/v1/brands?limit=50" \
  -H "Authorization: Bearer $SELLORCHARD_API_KEY"

Response200Brands.

Show response schema

dataarray of Brandrequired
ShowHide item attributes
- objectstringrequired
- idintegerrequired
  Id.
- namestringrequired
  Name.
- slugstringrequired
  URL handle.
- descriptionstring | nullrequired
  Description.
- websitestring | nullrequired
  Website.
- created_atstring<date-time> | nullrequired
  Created.
- updated_atstring<date-time> | nullrequired
  Last changed.
has_morebooleanrequired
More pages after this one.
next_cursorstring | nullrequired
Pass as cursor for the next page; null on the last page.

200 response

{
  "data": [
    {
      "object": "brand",
      "id": 4,
      "name": "Orchard",
      "slug": "orchard",
      "description": null,
      "website": "https://orchard.example",
      "created_at": "2026-11-02T15:00:00Z",
      "updated_at": "2026-11-03T09:30:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Error responses

400invalid_requestMalformed request (e.g. a bad cursor).
401authenticationMissing, invalid, expired or revoked API key.
403permissionThe key lacks the scope, or the store's plan doesn't include the API.
422invalid_requestInvalid parameters; errors lists each field.
429rate_limitedToo many requests.
500serverSomething went wrong on our side; safe to retry with the same Idempotency-Key.