Get category navigation tree

GET

/merchants/{merchantCode}/pathCategories

const url = 'https://catalog.shopgate.io/v1/merchants/example/pathCategories?getOriginalImageUrls=false';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://catalog.shopgate.io/v1/merchants/example/pathCategories?getOriginalImageUrls=false'

Get category navigation tree. Returns root categories with empty children when no categoryCode is provided. When categoryCode is provided, expands every ancestor on the path from root to target (showing their siblings) and loads the target’s immediate children.

Parameters

Path Parameters

merchantCode

required

string

<= 255 characters

Query Parameters

categoryCode

string

Optional category code to expand path to

localeCode

string

<= 5 characters

Locale code to change the language of the name, descriptions, properties and media

catalogCode

string

<= 255 characters

getOriginalImageUrls

boolean

Responses

200

Returns category tree.

application/json

object

categories

Array<object>

object

code

Human readable code of the entity

string

>= 1 characters <= 255 characters

parentCategoryCode

Human readable code of the entity

string

>= 1 characters <= 255 characters

image

null | string

<= 500 characters

name

string

<= 255 characters

url

Url of the category in the desktop shop

null | string

<= 255 characters

description

Description which is shown to the customer

null | string

externalUpdateDate

null | string format: date-time

status

string

Allowed values: active inactive

path

Category path based on the category code of the parents

Array<string>

sequenceId

By default this creates an ascending order of categories meaning 0 is the first.

integer

productCount

integer

categoryCount

integer

children

Array<object> recursive

Example

{
  "categories": [
    {
      "code": "clothes",
      "parentCategoryCode": null,
      "name": "Clothes",
      "description": "This category contains clothing",
      "image": null,
      "url": "https://awesomeShop.com/c/clothes",
      "externalUpdateDate": "2019-01-12T00:00:00.114Z",
      "status": "active",
      "path": [],
      "sequenceId": 0,
      "productCount": 0,
      "categoryCount": 2,
      "children": []
    }
  ]
}

404

Merchant or category not found

application/json

object

statusCode

number

code

required

string

message

required

string

Example

{
  "code": "NotFound",
  "message": "Merchant not found"
}