Categories

Commerce Resources · 5 endpoints

GET/v1/categories

List Categories

app_install_bearerscope: categories:read

Parameters

Field	Type	Required	Description
`type`query	`string`	optional	product, service, addon
`limit`query	`integer`	optional
`starting_after`query	`string`	optional
`ending_before`query	`string`	optional

Returns · 200

Field	Type	Required	Description
`data`

Loading documentation...

Field	Type	Required	Description
`data`

POST/v1/categories

Create Category

app_install_bearerscope: categories:writeidempotent

Parameters

Field	Type	Required	Description
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required	Description
`collection_type`	`string`	optional	manual, automated
`color`	`string`	optional
`description`	`string`	optional
`description_html`	`string`	optional
`icon`	`string`	optional
`image_alt_text`	`string`	optional
`image_url`	`string`	optional
`name`	`string`	required
`parent_category_id`	`string`	optional
`seo_description`	`string`	optional
`seo_title`	`string`	optional
`show_in_navigation`	`boolean`	optional
`slug`	`string`	optional
`sort_order`	`integer`	optional
`status`	`string`	optional	draft, published
`tax_code`	`string`	optional
`type`	`string`	optional	product, service, addon

Returns · 200

Field	Type	Required
`data`	`CategoryObject`	required
`data.collection_type`	`string`	optional
`data.color`	`string`	optional
`data.created_at`	`string`	optional
`data.description`	`string`	optional
`data.description_html`	`string`	optional
`data.icon`	`string`	optional
`data.id`	`string`	required
`data.image_alt_text`	`string`	optional

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/categories \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_type": "manual",
    "color": "color",
    "description": "description",
    "description_html": "description_html",
    "icon": "icon",
    "image_alt_text": "image_alt_text"
  }'

GET/v1/categories/{category_id}

Get Category

app_install_bearerscope: categories:read

Parameters

Field	Type	Required	Description
`category_id`path	`string`	required	Category public identifier in catg_<21 Base62> format.

Returns · 200

Field	Type	Required	Description
`data`	`CategoryObject`	required
`data.collection_type`	`string`	optional
`data.color`	`string`	optional
`data.created_at`	`string`	optional
`data.description`	`string`	optional
`data.description_html`	`string`	optional
`data.icon`	`string`	optional
`data.id`	`string`	required
`data.image_alt_text`	`string`	optional
`data.image_url`	`string`	optional
`data.name`	`string`	required
`data.object`	`string`	optional	category
`data.parent_category_id`	`string`	optional
`data.seo_description`	`string`	optional
`data.seo_title`	`string`	optional
`data.show_in_navigation`	`boolean`	optional
`data.slug`	`string`	optional
`data.sort_order`	`integer`	optional
`data.status`	`string`	optional
`data.tax_code`	`string`	optional
`data.type`	`string`	optional	product, service, addon
`data.updated_at`	`string`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/categories/{category_id} \
  -H "Authorization: Bearer $GETME_API_KEY"

PATCH/v1/categories/{category_id}

Update Category

app_install_bearerscope: categories:writeidempotent

Parameters

Field	Type	Required	Description
`category_id`path	`string`	required	Category public identifier in catg_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required	Description
`collection_type`	`string`	optional	manual, automated
`color`	`string`	optional
`description`	`string`	optional
`description_html`	`string`	optional
`icon`	`string`	optional
`image_alt_text`	`string`	optional
`image_url`	`string`	optional
`name`	`string`	optional
`parent_category_id`	`string`	optional
`seo_description`	`string`	optional
`seo_title`	`string`	optional
`show_in_navigation`	`boolean`	optional
`slug`	`string`	optional
`sort_order`	`integer`	optional
`status`	`string`	optional	draft, published
`tax_code`	`string`	optional
`type`	`string`	optional	product, service, addon

Returns · 200

Field	Type	Required
`data`	`CategoryObject`	required
`data.collection_type`	`string`	optional
`data.color`	`string`	optional
`data.created_at`	`string`	optional
`data.description`	`string`	optional
`data.description_html`	`string`	optional
`data.icon`	`string`	optional
`data.id`	`string`	required
`data.image_alt_text`	`string`	optional

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/categories/{category_id} \
  -X PATCH \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_type": "manual",
    "color": "color",
    "description": "description",
    "description_html": "description_html",
    "icon": "icon",
    "image_alt_text": "image_alt_text"
  }'

POST/v1/categories/{category_id}/archive

Archive Category

app_install_bearerscope: categories:writeidempotent

Parameters

Field	Type	Required	Description
`category_id`path	`string`	required	Category public identifier in catg_<21 Base62> format.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Returns · 200

Field	Type	Required	Description
`data`	`CategoryObject`	required
`data.collection_type`	`string`	optional
`data.color`	`string`	optional
`data.created_at`	`string`	optional
`data.description`	`string`	optional
`data.description_html`	`string`	optional
`data.icon`	`string`	optional
`data.id`	`string`	required
`data.image_alt_text`	`string`	optional
`data.image_url`	`string`	optional
`data.name`	`string`	required
`data.object`	`string`	optional	category
`data.parent_category_id`	`string`	optional
`data.seo_description`	`string`	optional
`data.seo_title`	`string`	optional
`data.show_in_navigation`	`boolean`	optional
`data.slug`	`string`	optional
`data.sort_order`	`integer`	optional
`data.status`	`string`	optional
`data.tax_code`	`string`	optional
`data.type`	`string`	optional	product, service, addon
`data.updated_at`	`string`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/categories/{category_id}/archive \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef"