Categories Update

Authorization

oauth2 catalogue:write

AuthorizationBearer <token>

Generate an Access Token through Settings > API Access for single store access or use the Authorization Code flow with your partner App Client ID. Use required permission scopes for API endpoint access. Example Authorization: Bearer 123

In: header

Scope: catalogue:write

Path Parameters

id*integer

A unique integer value identifying this Category.

Header Parameters

X-29next-API-Version*string

Default"2024-04-01"

Value in"2024-04-01"

Request Body

description?string

external_tax_code?|

Tax code to be used with external tax systems such as Avalara, Taxjar.

image?|

URL of the image to fetch and associate with the category

Formaturi

is_public?boolean

Show this category in search results and catalogue listings.

meta_description?|

meta_title?|

name*string

Lengthlength <= 255

slug*string

Match^[-a-zA-Z0-9_]+$

Lengthlength <= 255

template?|

Use a custom template from your theme to customize the category display.

Response Body

`application/json`

curl -X PUT "https://example.29next.store/api/admin/categories/0/" \
  -H "X-29next-API-Version: 2024-04-01" \
  -H "Authorization: Bearer " \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "slug": "string"
  }'

{
  "description": "string",
  "external_tax_code": "string",
  "id": 0,
  "image": "http://example.com",
  "is_public": true,
  "meta_description": "string",
  "meta_title": "string",
  "name": "string",
  "slug": "string",
  "template": "string"
}