Categories

CTG101: Get Categories

get

Authorizations

Token

AuthorizationstringRequired

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Responses

200

OK

application/json

idstring · uuidOptional

Unique identifier for the category.

Example: 07be580a-ad72-4778-b309-1d02d6c2acec

namestringOptional

Name of the category.

Example: T-Shirts

parentstring · uuidOptional

Unique identifier for the parent category.

Example: e6f871e8-7b1e-4d6e-b06d-6487a075a214

childrenarrayOptional

Array of child categories associated with the category. Shares the same structure as the above.

401

Unauthorized

application/json

500

Unexpected error.

get

/i2/categories/

HTTPcURLJavaScriptPython

GET /api/i2/categories/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "db9782e6-5818-4f65-bcf6-ac1d35c3d8a4",
    "name": "Akinon Marketplace Category",
    "parent": null,
    "children": [
      {
        "id": "eadc41b4-0608-42e2-a73d-82cc8e7d6292",
        "name": "Man",
        "children": [
          {
            "id": "45e31829-7e54-446e-bb5a-65cdc0141aff",
            "name": "T-Shirts",
            "parent": "eadc41b4-0608-42e2-a73d-82cc8e7d6292"
          },
          {
            "id": "7cacc26a-feeb-4ee3-866a-fa027d726e01",
            "name": "Jeans",
            "parent": "eadc41b4-0608-42e2-a73d-82cc8e7d6292"
          }
        ]
      },
      {
        "id": "7f089139-8c1b-435e-a2f0-3efbb00b9398",
        "name": "Woman",
        "children": [
          {
            "id": "54c7549f-c133-4494-9253-fe1a38a86322",
            "name": "T-Shirts",
            "parent": "7f089139-8c1b-435e-a2f0-3efbb00b9398"
          },
          {
            "id": "e0fc7878-25b3-4bae-9d6b-3c7abf1ef698",
            "name": "Skirts",
            "parent": "7f089139-8c1b-435e-a2f0-3efbb00b9398"
          }
        ]
      }
    ]
  }
]

CTG102: Get Category Attributes

get

Authorizations

Token

AuthorizationstringRequired

Path parameters

idstring · uuidRequired

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Responses

200

OK

application/json

keystringOptional

Unique identifier or key for the attribute.

Example: COLOR

namestringOptional

Human-readable name of the attribute.

Example: Color

data_typestring · enumOptional

Data type of the attribute.

Example: dropdownPossible values:

default_valuestringOptional

Default value for the attribute.

Default: nullExample: White

is_requiredbooleanOptional

Indicates whether the attribute is required.

Example: true

is_variantbooleanOptional

Indicates whether the attribute is a variant.

Example: true

is_offerbooleanOptional

Indicates a specific attribute that can be defined when creating a product but cannot be updated during editing.

Example: true

is_localizablebooleanOptional

Indicates whether the attribute is localizable (can have translations).

Example: true

translationsobjectOptional

Translations for the attribute name in different languages.

Default: nullExample: {"en-gb":{"name":"Colour"}}

401

Unauthorized

application/json

404

Given resource or object is not found or available.

application/json

500

Unexpected error.

get

/i2/categories/{id}/attributes/

HTTPcURLJavaScriptPython

GET /api/i2/categories/{id}/attributes/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "key": "COLOR",
    "name": "Color",
    "data_type": "dropdown",
    "default_value": "White",
    "values": [
      {
        "id": "07be580a-ad72-4778-b309-1d02d6c2acec",
        "label": "Red",
        "value": "R",
        "translations": {
          "en-gb": {
            "label": "Red"
          }
        }
      }
    ],
    "is_required": true,
    "is_variant": true,
    "is_offer": true,
    "is_localizable": true,
    "translations": {
      "en-gb": {
        "name": "Colour"
      }
    }
  }
]

CTG103: Get Category by ID

get

Authorizations

Token

AuthorizationstringRequired

Path parameters

idstring · uuidRequired

Header parameters

Accept-LanguagestringOptional

Specifies the communication language of the API.

Responses

200

OK

application/json

idstring · uuidOptional

Unique identifier for the category.

Example: 07be580a-ad72-4778-b309-1d02d6c2acec

namestringOptional

Name of the category.

Example: T-Shirts

parentstring · uuidOptional

Unique identifier for the parent category.

Example: e6f871e8-7b1e-4d6e-b06d-6487a075a214

401

Unauthorized

application/json

404

Given resource or object is not found or available.

application/json

500

Unexpected error.

get

/i2/categories/{id}/

HTTPcURLJavaScriptPython

GET /api/i2/categories/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "07be580a-ad72-4778-b309-1d02d6c2acec",
  "name": "T-Shirts",
  "parent": "e6f871e8-7b1e-4d6e-b06d-6487a075a214"
}