GetCandy

The GetCandy API

This is the documentation for version 1.0 of the API. Last update on Jun 24, 2020.

Base URL
http://localhost:3000/api/v1

Channels

Store channels

Get all channels

Gets a paginated list of all channel

URL parameters
  • includes string

    Comma separated includes for the resource

  • per_page number

    How many results per page

Responses
  • 200 object

    OK

    • data array[object]
      • data.id string
      • data.name string
      • data.handle string
      • data.url string(uri)
      • data.default boolean
    • current_page integer(int32)
    • from integer
    • last_page integer
    • path string
    • per_page integer
    • to integer
    • total integer
Definition
GET http://localhost:3000/api/v1/channels
cURL example
curl \ -X GET http://localhost:3000/api/v1/channels \ -H "Content-Type: application/json"
Response example (200)
{ "data": [ { "default": true, "name": "Webstore", "handle": "webstore", "id": "y3g6v91o", "url": "https:\\/\\/storefront.test" } ], "current_page": 1, "from": 24, "last_page": 15, "path": "string", "per_page": 1, "to": 42, "total": 42 }

Create a new channel

Create a new channel resource

Body
  • handle string
  • name string
Responses
  • 200 object

    OK

    • id string
    • name string
    • handle string
    • url string(uri)
    • default boolean
Definition
POST http://localhost:3000/api/v1/channels
cURL example
curl \ -X POST http://localhost:3000/api/v1/channels \ -H "Content-Type: application/json" \ -d '{"handle":"string","name":"string"}'
Request payload example
{ "handle": "string", "name": "string" }
Response example (200)
{ "id": "y3g6v91o", "name": "Webstore", "handle": "webstore", "url": "https:\\/\\/storefront.test", "default": true }

Get the channel resource

URL parameters
  • channelId Required / string
  • includes string
Responses
  • 200 object

    OK

    • data object

      Available includes

      • products
      • categories
      • collections
      • discounts
      • shippingMethods
      • data.id string
      • data.name string
      • data.handle string
      • data.url string(uri)
      • data.default boolean
  • 404 object

    Not Found

    • error object
      • error.http_code integer
      • error.message string
Definition
GET http://localhost:3000/api/v1/channels/{channelId}
cURL example
curl \ -X GET http://localhost:3000/api/v1/channels/{channelId} \ -H "Content-Type: application/json"
Response example (200)
{ "data": { "id": "y3g6v91o", "name": "Webstore", "handle": "webstore", "url": "http://webstore.test", "default": true, "published_at": null }, "meta": { "lang": "en" } }
Response example (404)
{ "error": { "http_code": 404, "message": "Resource not found" } }

Update the channel resource

URL parameters
  • channelId Required / string
Body
  • handle string
  • name string
Responses
  • 200 object

    OK

    • data object

      Available includes

      • products
      • categories
      • collections
      • discounts
      • shippingMethods
      • data.id string
      • data.name string
      • data.handle string
      • data.url string(uri)
      • data.default boolean
  • 422 object

    Unprocessable Entity

    • handle array[string]
    • name array[string]
Definition
PUT http://localhost:3000/api/v1/channels/{channelId}
cURL example
curl \ -X PUT http://localhost:3000/api/v1/channels/{channelId} \ -H "Content-Type: application/json" \ -d '{"handle":"string","name":"string"}'
Request payload example
{ "handle": "string", "name": "string" }
Response example (200)
{ "data": { "default": true, "name": "Webstore", "handle": "webstore", "id": "y3g6v91o", "url": "https:\\/\\/storefront.test" } }
Response example (422)
{ "handle": [ "string" ], "name": [ "string" ] }

Delete the channel resource

URL parameters
  • channelId Required / string
Responses
  • 204

    No Content

Definition
DELETE http://localhost:3000/api/v1/channels/{channelId}
cURL example
curl \ -X DELETE http://localhost:3000/api/v1/channels/{channelId} \ -H "Content-Type: application/json"
Response example (204)
No content

Categories

Catalogue Management

Return a paged array of categories

Returns a paginated resource of categories

URL parameters
  • full_response boolean
  • include string
  • tree boolean

    Whether response should be a node tree

Responses
  • 200 object

    OK

    • data array[object]
      • data.id string
      • data.sort string
      • data.products_count integer
      • data.children_count integer
      • data.left_pos integer
      • data.right_pos integer
      • data.name string
      • data.attribute_data object
      • data.
      • data.channels object
        • data.channels.data array[object]
          • data.channels.data.id string
          • data.channels.data.name string
          • data.channels.data.handle string
          • data.channels.data.url string(uri)
          • data.channels.data.default boolean
        • data.channels.current_page integer(int32)
        • data.channels.from integer
        • data.channels.last_page integer
        • data.channels.path string
        • data.channels.per_page integer
        • data.channels.to integer
        • data.channels.total integer
      • data.
      • data.routes object
        • data.routes.data array[object]
          • data.routes.data.id string
          • data.routes.data.default boolean
          • data.routes.data.redirect boolean
          • data.routes.data.locale string
          • data.routes.data.path string
          • data.routes.data.slug string
          • data.routes.data.description string
          • data.routes.data.type string
          • data.routes.data.element object
            • data.routes.data.element.data object
              • data.routes.data.element.data.id string
        • data.routes.meta object
          • data.routes.meta.current_page integer(int32)
          • data.routes.meta.from integer
          • data.routes.meta.last_page integer
          • data.routes.meta.path string
          • data.routes.meta.per_page integer
          • data.routes.meta.to integer
          • data.routes.meta.total integer
        • data.routes.links object
          • data.routes.links.first string
          • data.routes.links.last string
          • data.routes.links.prev string
          • data.routes.links.next string
      • data.layout object
        • data.layout.data object
          • data.layout.data.id Required / string
          • data.layout.data.name Required / string
          • data.layout.data.handle Required / string
          • data.layout.data.type Required / string
      • data.assets object
        • data.assets.data array[object]
          • data.assets.data.id string
          • data.assets.data.title string
          • data.assets.data.type string
          • data.assets.data.caption string
          • data.assets.data.kind string
          • data.assets.data.external boolean
          • data.assets.data.position integer
          • data.assets.data.primary boolean
          • data.assets.data.url string
          • data.assets.data.sub_kind string
          • data.assets.data.extension string
          • data.assets.data.original_filename string
          • data.assets.data.size string
          • data.assets.data.width string
          • data.assets.data.height string
          • data.assets.data.transforms object
            • data.assets.data.transforms.data array[object]
              • data.assets.data.transforms.data.id string
              • data.assets.data.transforms.data.handle string
              • data.assets.data.transforms.data.url string
            • data.assets.data.transforms.meta object
              • data.assets.data.transforms.meta.current_page integer(int32)
              • data.assets.data.transforms.meta.from integer
              • data.assets.data.transforms.meta.last_page integer
              • data.assets.data.transforms.meta.path string
              • data.assets.data.transforms.meta.per_page integer
              • data.assets.data.transforms.meta.to integer
              • data.assets.data.transforms.meta.total integer
            • data.assets.data.transforms.links object
              • data.assets.data.transforms.links.first string
              • data.assets.data.transforms.links.last string
              • data.assets.data.transforms.links.prev string
              • data.assets.data.transforms.links.next string
          • data.assets.data.tags object
            • data.assets.data.tags.data array[object]
              • data.assets.data.tags.data.id string
              • data.assets.data.tags.data.name string
            • data.assets.data.tags.meta object
              • data.assets.data.tags.meta.current_page integer(int32)
              • data.assets.data.tags.meta.from integer
              • data.assets.data.tags.meta.last_page integer
              • data.assets.data.tags.meta.path string
              • data.assets.data.tags.meta.per_page integer
              • data.assets.data.tags.meta.to integer
              • data.assets.data.tags.meta.total integer
            • data.assets.data.tags.links object
              • data.assets.data.tags.links.first string
              • data.assets.data.tags.links.last string
              • data.assets.data.tags.links.prev string
              • data.assets.data.tags.links.next string
      • data.primary_asset object
        • data.primary_asset.data object
          • data.primary_asset.data.id string
          • data.primary_asset.data.title string
          • data.primary_asset.data.type string
          • data.primary_asset.data.caption string
          • data.primary_asset.data.kind string
          • data.primary_asset.data.external boolean
          • data.primary_asset.data.position integer
          • data.primary_asset.data.primary boolean
          • data.primary_asset.data.url string
          • data.primary_asset.data.sub_kind string
          • data.primary_asset.data.extension string
          • data.primary_asset.data.original_filename string
          • data.primary_asset.data.size string
          • data.primary_asset.data.width string
          • data.primary_asset.data.height string
          • data.primary_asset.data.transforms object
            • data.primary_asset.data.transforms.data array[object]
              • data.primary_asset.data.transforms.data.id string
              • data.primary_asset.data.transforms.data.handle string
              • data.primary_asset.data.transforms.data.url string
            • data.primary_asset.data.transforms.meta object
              • data.primary_asset.data.transforms.meta.current_page integer(int32)
              • data.primary_asset.data.transforms.meta.from integer
              • data.primary_asset.data.transforms.meta.last_page integer
              • data.primary_asset.data.transforms.meta.path string
              • data.primary_asset.data.transforms.meta.per_page integer
              • data.primary_asset.data.transforms.meta.to integer
              • data.primary_asset.data.transforms.meta.total integer
            • data.primary_asset.data.transforms.links object
              • data.primary_asset.data.transforms.links.first string
              • data.primary_asset.data.transforms.links.last string
              • data.primary_asset.data.transforms.links.prev string
              • data.primary_asset.data.transforms.links.next string
          • data.primary_asset.data.tags object
            • data.primary_asset.data.tags.data array[object]
              • data.primary_asset.data.tags.data.id string
              • data.primary_asset.data.tags.data.name string
            • data.primary_asset.data.tags.meta object
              • data.primary_asset.data.tags.meta.current_page integer(int32)
              • data.primary_asset.data.tags.meta.from integer
              • data.primary_asset.data.tags.meta.last_page integer
              • data.primary_asset.data.tags.meta.path string
              • data.primary_asset.data.tags.meta.per_page integer
              • data.primary_asset.data.tags.meta.to integer
              • data.primary_asset.data.tags.meta.total integer
            • data.primary_asset.data.tags.links object
              • data.primary_asset.data.tags.links.first string
              • data.primary_asset.data.tags.links.last string
              • data.primary_asset.data.tags.links.prev string
              • data.primary_asset.data.tags.links.next string
      • data.attributes object
        • data.attributes.data array[object]
          • data.attributes.data.id string
          • data.attributes.data.name object
          • data.attributes.data.handle string
          • data.attributes.data.position integer
          • data.attributes.data.filterable boolean
          • data.attributes.data.scopeable boolean
          • data.attributes.data.translatable boolean
          • data.attributes.data.variant boolean
          • data.attributes.data.searchable boolean
          • data.attributes.data.localised boolean
          • data.attributes.data.type string
          • data.attributes.data.required boolean
          • data.attributes.data.lookups array[object]
          • data.attributes.data.system boolean
          • data.attributes.data.group object
            • data.attributes.data.group.data object
              Available includes
              • attributes
              • data.attributes.data.group.data.id string
              • data.attributes.data.group.data.name object
              • data.attributes.data.group.data.handle string
              • data.attributes.data.group.data.position integer(int32)
              • data.attributes.data.group.data.
        • data.attributes.meta object
          • data.attributes.meta.current_page integer(int32)
          • data.attributes.meta.from integer
          • data.attributes.meta.last_page integer
          • data.attributes.meta.path string
          • data.attributes.meta.per_page integer
          • data.attributes.meta.to integer
          • data.attributes.meta.total integer
        • data.attributes.links object
          • data.attributes.links.first string
          • data.attributes.links.last string
          • data.attributes.links.prev string
          • data.attributes.links.next string
      • data.customer_groups object
        • data.customer_groups.data array[object]
          • data.customer_groups.data.id string
          • data.customer_groups.data.name string
          • data.customer_groups.data.handle string
          • data.customer_groups.data.visible string
          • data.customer_groups.data.purchasable boolean
        • data.customer_groups.meta object
          • data.customer_groups.meta.current_page integer(int32)
          • data.customer_groups.meta.from integer
          • data.customer_groups.meta.last_page integer
          • data.customer_groups.meta.path string
          • data.customer_groups.meta.per_page integer
          • data.customer_groups.meta.to integer
          • data.customer_groups.meta.total integer
        • data.customer_groups.links object
          • data.customer_groups.links.first string
          • data.customer_groups.links.last string
          • data.customer_groups.links.prev string
          • data.customer_groups.links.next string
      • data.products object
        • data.products.data array[]
        • data.products.meta object
          • data.products.meta.current_page integer(int32)
          • data.products.meta.from integer
          • data.products.meta.last_page integer
          • data.products.meta.path string
          • data.products.meta.per_page integer
          • data.products.meta.to integer
          • data.products.meta.total integer
        • data.products.links object
          • data.products.links.first string
          • data.products.links.last string
          • data.products.links.prev string
          • data.products.links.next string
    • meta object
      • meta.current_page integer(int32)
      • meta.from integer
      • meta.last_page integer
      • meta.path string
      • meta.per_page integer
      • meta.to integer
      • meta.total integer
    • links object
      • links.first string
      • links.last string
      • links.prev string
      • links.next string
Definition
GET http://localhost:3000/api/v1/categories
cURL example
curl \ -X GET http://localhost:3000/api/v1/categories \ -H "Content-Type: application/json"
Response example (200)
{ "data": [ { "primary_asset": { "data": { "extension": "extension", "kind": "kind", "caption": "caption", "title": "title", "type": "type", "url": "url", "external": true, "original_filename": "original_filename", "size": "size", "width": "width", "id": "id", "position": 5, "sub_kind": "sub_kind", "primary": true, "height": "height" } }, "children_count": 6, "products_count": 0, "sort": "sort", "left_pos": 1, "right_pos": 5, "layout": { "data": { "name": "name", "handle": "handle", "id": "id", "type": "type" } }, "assets": { "data": [ { "extension": "extension", "kind": "kind", "caption": "caption", "title": "title", "type": "type", "url": "url", "external": true, "original_filename": "original_filename", "size": "size", "width": "width", "id": "id", "position": 5, "sub_kind": "sub_kind", "primary": true, "height": "height" }, { "extension": "extension", "kind": "kind", "caption": "caption", "title": "title", "type": "type", "url": "url", "external": true, "original_filename": "original_filename", "size": "size", "width": "width", "id": "id", "position": 5, "sub_kind": "sub_kind", "primary": true, "height": "height" } ] }, "name": "name", "id": "id", "attribute_data": "{}" } ], "meta": { "current_page": 1, "from": 24, "last_page": 15, "path": "string", "per_page": 1, "to": 42, "total": 42 }, "links": { "next": "next", "last": "last", "prev": "prev", "first": "first" } }

Create a new category

Creates a new category and returns it's resource.

Body
  • url Required / string
  • path Required / string
  • name Required / object
    • name.en Required / string
Responses
  • 200 object

    OK

    • data object
      Available includes
      • children
      • data.id string
      • data.sort string
      • data.products_count integer
      • data.children_count integer
      • data.left_pos integer
      • data.right_pos integer
      • data.name string
      • data.attribute_data object
      • data.
      • data.channels object
        • data.channels.data array[object]
          • data.channels.data.id string
          • data.channels.data.name string
          • data.channels.data.handle string
          • data.channels.data.url string(uri)
          • data.channels.data.default boolean
        • data.channels.current_page integer(int32)
        • data.channels.from integer
        • data.channels.last_page integer
        • data.channels.path string
        • data.channels.per_page integer
        • data.channels.to integer
        • data.channels.total integer
      • data.
      • data.routes object
        • data.routes.data array[object]
          • data.routes.data.id string
          • data.routes.data.default boolean
          • data.routes.data.redirect boolean
          • data.routes.data.locale string
          • data.routes.data.path string
          • data.routes.data.slug string
          • data.routes.data.description string
          • data.routes.data.type string
          • data.routes.data.element object
            • data.routes.data.element.data object
              • data.routes.data.element.data.id string
        • data.routes.meta object
          • data.routes.meta.current_page integer(int32)
          • data.routes.meta.from integer
          • data.routes.meta.last_page integer
          • data.routes.meta.path string
          • data.routes.meta.per_page integer
          • data.routes.meta.to integer
          • data.routes.meta.total integer
        • data.routes.links object
          • data.routes.links.first string
          • data.routes.links.last string
          • data.routes.links.prev string
          • data.routes.links.next string
      • data.layout object
        • data.layout.data object
          • data.layout.data.id Required / string
          • data.layout.data.name Required / string
          • data.layout.data.handle Required / string
          • data.layout.data.type Required / string
      • data.assets object
        • data.assets.data array[object]
          • data.assets.data.id string
          • data.assets.data.title string
          • data.assets.data.type string
          • data.assets.data.caption string
          • data.assets.data.kind string
          • data.assets.data.external boolean
          • data.assets.data.position integer
          • data.assets.data.primary boolean
          • data.assets.data.url string
          • data.assets.data.sub_kind string
          • data.assets.data.extension string
          • data.assets.data.original_filename string
          • data.assets.data.size string
          • data.assets.data.width string
          • data.assets.data.height string
          • data.assets.data.transforms object
            • data.assets.data.transforms.data array[object]
              • data.assets.data.transforms.data.id string
              • data.assets.data.transforms.data.handle string
              • data.assets.data.transforms.data.url string
            • data.assets.data.transforms.meta object
              • data.assets.data.transforms.meta.current_page integer(int32)
              • data.assets.data.transforms.meta.from integer
              • data.assets.data.transforms.meta.last_page integer
              • data.assets.data.transforms.meta.path string
              • data.assets.data.transforms.meta.per_page integer
              • data.assets.data.transforms.meta.to integer
              • data.assets.data.transforms.meta.total integer
            • data.assets.data.transforms.links object
              • data.assets.data.transforms.links.first string
              • data.assets.data.transforms.links.last string
              • data.assets.data.transforms.links.prev string
              • data.assets.data.transforms.links.next string
          • data.assets.data.tags object
            • data.assets.data.tags.data array[object]
              • data.assets.data.tags.data.id string
              • data.assets.data.tags.data.name string
            • data.assets.data.tags.meta object
              • data.assets.data.tags.meta.current_page integer(int32)
              • data.assets.data.tags.meta.from integer
              • data.assets.data.tags.meta.last_page integer
              • data.assets.data.tags.meta.path string
              • data.assets.data.tags.meta.per_page integer
              • data.assets.data.tags.meta.to integer
              • data.assets.data.tags.meta.total integer
            • data.assets.data.tags.links object
              • data.assets.data.tags.links.first string
              • data.assets.data.tags.links.last string
              • data.assets.data.tags.links.prev string
              • data.assets.data.tags.links.next string
      • data.primary_asset object
        • data.primary_asset.data object
          • data.primary_asset.data.id string
          • data.primary_asset.data.title string
          • data.primary_asset.data.type string
          • data.primary_asset.data.caption string
          • data.primary_asset.data.kind string
          • data.primary_asset.data.external boolean
          • data.primary_asset.data.position integer
          • data.primary_asset.data.primary boolean
          • data.primary_asset.data.url string
          • data.primary_asset.data.sub_kind string
          • data.primary_asset.data.extension string
          • data.primary_asset.data.original_filename string
          • data.primary_asset.data.size string
          • data.primary_asset.data.width string
          • data.primary_asset.data.height string
          • data.primary_asset.data.transforms object
            • data.primary_asset.data.transforms.data array[object]
              • data.primary_asset.data.transforms.data.id string
              • data.primary_asset.data.transforms.data.handle string
              • data.primary_asset.data.transforms.data.url string
            • data.primary_asset.data.transforms.meta object
              • data.primary_asset.data.transforms.meta.current_page integer(int32)
              • data.primary_asset.data.transforms.meta.from integer
              • data.primary_asset.data.transforms.meta.last_page integer
              • data.primary_asset.data.transforms.meta.path string
              • data.primary_asset.data.transforms.meta.per_page integer
              • data.primary_asset.data.transforms.meta.to integer
              • data.primary_asset.data.transforms.meta.total integer
            • data.primary_asset.data.transforms.links object
              • data.primary_asset.data.transforms.links.first string
              • data.primary_asset.data.transforms.links.last string
              • data.primary_asset.data.transforms.links.prev string
              • data.primary_asset.data.transforms.links.next string
          • data.primary_asset.data.tags object
            • data.primary_asset.data.tags.data array[object]
              • data.primary_asset.data.tags.data.id string
              • data.primary_asset.data.tags.data.name string
            • data.primary_asset.data.tags.meta object
              • data.primary_asset.data.tags.meta.current_page integer(int32)
              • data.primary_asset.data.tags.meta.from integer
              • data.primary_asset.data.tags.meta.last_page integer
              • data.primary_asset.data.tags.meta.path string
              • data.primary_asset.data.tags.meta.per_page integer
              • data.primary_asset.data.tags.meta.to integer
              • data.primary_asset.data.tags.meta.total integer
            • data.primary_asset.data.tags.links object
              • data.primary_asset.data.tags.links.first string
              • data.primary_asset.data.tags.links.last string
              • data.primary_asset.data.tags.links.prev string
              • data.primary_asset.data.tags.links.next string
      • data.attributes object
        • data.attributes.data array[object]
          • data.attributes.data.id string
          • data.attributes.data.name object
          • data.attributes.data.handle string
          • data.attributes.data.position integer
          • data.attributes.data.filterable boolean
          • data.attributes.data.scopeable boolean
          • data.attributes.data.translatable boolean
          • data.attributes.data.variant boolean
          • data.attributes.data.searchable boolean
          • data.attributes.data.localised boolean
          • data.attributes.data.type string
          • data.attributes.data.required boolean
          • data.attributes.data.lookups array[object]
          • data.attributes.data.system boolean
          • data.attributes.data.group object
            • data.attributes.data.group.data object
              Available includes
              • attributes
              • data.attributes.data.group.data.id string
              • data.attributes.data.group.data.name object
              • data.attributes.data.group.data.handle string
              • data.attributes.data.group.data.position integer(int32)
              • data.attributes.data.group.data.
        • data.attributes.meta object
          • data.attributes.meta.current_page integer(int32)
          • data.attributes.meta.from integer
          • data.attributes.meta.last_page integer
          • data.attributes.meta.path string
          • data.attributes.meta.per_page integer
          • data.attributes.meta.to integer
          • data.attributes.meta.total integer
        • data.attributes.links object
          • data.attributes.links.first string
          • data.attributes.links.last string
          • data.attributes.links.prev string
          • data.attributes.links.next string
      • data.customer_groups object
        • data.customer_groups.data array[object]
          • data.customer_groups.data.id string
          • data.customer_groups.data.name string
          • data.customer_groups.data.handle string
          • data.customer_groups.data.visible string
          • data.customer_groups.data.purchasable boolean
        • data.customer_groups.meta object
          • data.customer_groups.meta.current_page integer(int32)
          • data.customer_groups.meta.from integer
          • data.customer_groups.meta.last_page integer
          • data.customer_groups.meta.path string
          • data.customer_groups.meta.per_page integer
          • data.customer_groups.meta.to integer
          • data.customer_groups.meta.total integer
        • data.customer_groups.links object
          • data.customer_groups.links.first string
          • data.customer_groups.links.last string
          • data.customer_groups.links.prev string
          • data.customer_groups.links.next string
      • data.products object
        • data.products.data array[]
        • data.products.meta object
          • data.products.meta.current_page integer(int32)
          • data.products.meta.from integer
          • data.products.meta.last_page integer
          • data.products.meta.path string
          • data.products.meta.per_page integer
          • data.products.meta.to integer
          • data.products.meta.total integer
        • data.products.links object
          • data.products.links.first string
          • data.products.links.last string
          • data.products.links.prev string
          • data.products.links.next string
  • 422 object

    Unprocessable Entity

    • error object
      • error.http_code integer
      • error.message string
Definition
POST http://localhost:3000/api/v1/categories
cURL example
curl \ -X POST http://localhost:3000/api/v1/categories \ -H "Content-Type: application/json" \ -d '{"url":"string","path":"string","name":{"en":"en"}}'
Request payload example
{ "url": "string", "path": "string", "name": { "en": "en" } }
Response example (200)
{ "data": { "primary_asset": { "data": { "extension": "extension", "kind": "kind", "caption": "caption", "title": "title", "type": "type", "url": "url", "external": true, "original_filename": "original_filename", "size": "size", "width": "width", "id": "id", "position": 5, "sub_kind": "sub_kind", "primary": true, "height": "height" } }, "children_count": 6, "products_count": 0, "sort": "sort", "left_pos": 1, "right_pos": 5, "layout": { "data": { "name": "name", "handle": "handle", "id": "id", "type": "type" } }, "assets": { "data": [ { "extension": "extension", "kind": "kind", "caption": "caption", "title": "title", "type": "type", "url": "url", "external": true, "original_filename": "original_filename", "size": "size", "width": "width", "id": "id", "position": 5, "sub_kind": "sub_kind", "primary": true, "height": "height" }, { "extension": "extension", "kind": "kind", "caption": "caption", "title": "title", "type": "type", "url": "url", "external": true, "original_filename": "original_filename", "size": "size", "width": "width", "id": "id", "position": 5, "sub_kind": "sub_kind", "primary": true, "height": "height" } ] }, "name": "name", "id": "id", "attribute_data": "{}" } }
Response example (422)
{ "url": [ "The url field is required." ] }

Return a single category

Returns a single category from a given ID

URL parameters
  • categoryId Required / string
  • includes string
Responses
  • 200 object

    OK

    • data object
      Available includes
      • children
      • data.id string
      • data.sort string
      • data.products_count integer
      • data.children_count integer
      • data.left_pos integer
      • data.right_pos integer
      • data.name string
      • data.attribute_data object
      • data.
      • data.channels object
        • data.channels.data array[object]
          • data.channels.data.id string
          • data.channels.data.name string
          • data.channels.data.handle string
          • data.channels.data.url string(uri)
          • data.channels.data.default boolean
        • data.channels.current_page integer(int32)
        • data.channels.from integer
        • data.channels.last_page integer
        • data.channels.path string
        • data.channels.per_page integer
        • data.channels.to integer
        • data.channels.total integer
      • data.
      • data.routes object
        • data.routes.data array[object]
          • data.routes.data.id string
          • data.routes.data.default boolean
          • data.routes.data.redirect boolean
          • data.routes.data.locale string
          • data.routes.data.path string
          • data.routes.data.slug string
          • data.routes.data.description string
          • data.routes.data.type string
          • data.routes.data.element object
            • data.routes.data.element.data object
              • data.routes.data.element.data.id string
        • data.routes.meta object
          • data.routes.meta.current_page integer(int32)
          • data.routes.meta.from integer
          • data.routes.meta.last_page integer
          • data.routes.meta.path string
          • data.routes.meta.per_page integer
          • data.routes.meta.to integer
          • data.routes.meta.total integer
        • data.routes.links object
          • data.routes.links.first string
          • data.routes.links.last string
          • data.routes.links.prev string
          • data.routes.links.next string
      • data.layout object
        • data.layout.data object
          • data.layout.data.id Required / string
          • data.layout.data.name Required / string
          • data.layout.data.handle Required / string
          • data.layout.data.type Required / string
      • data.assets object
        • data.assets.data array[object]
          • data.assets.data.id string
          • data.assets.data.title string
          • data.assets.data.type string
          • data.assets.data.caption string
          • data.assets.data.kind string
          • data.assets.data.external boolean
          • data.assets.data.position integer
          • data.assets.data.primary boolean
          • data.assets.data.url string
          • data.assets.data.sub_kind string
          • data.assets.data.extension string
          • data.assets.data.original_filename string
          • data.assets.data.size string
          • data.assets.data.width string
          • data.assets.data.height string
          • data.assets.data.transforms object
            • data.assets.data.transforms.data array[object]
              • data.assets.data.transforms.data.id string
              • data.assets.data.transforms.data.handle string
              • data.assets.data.transforms.data.url string
            • data.assets.data.transforms.meta object
              • data.assets.data.transforms.meta.current_page integer(int32)
              • data.assets.data.transforms.meta.from integer
              • data.assets.data.transforms.meta.last_page integer
              • data.assets.data.transforms.meta.path string
              • data.assets.data.transforms.meta.per_page integer
              • data.assets.data.transforms.meta.to integer
              • data.assets.data.transforms.meta.total integer
            • data.assets.data.transforms.links object
              • data.assets.data.transforms.links.first string
              • data.assets.data.transforms.links.last string
              • data.assets.data.transforms.links.prev string
              • data.assets.data.transforms.links.next string
          • data.assets.data.tags object
            • data.assets.data.tags.data array[object]
              • data.assets.data.tags.data.id string
              • data.assets.data.tags.data.name string
            • data.assets.data.tags.meta object
              • data.assets.data.tags.meta.current_page integer(int32)
              • data.assets.data.tags.meta.from integer
              • data.assets.data.tags.meta.last_page integer
              • data.assets.data.tags.meta.path string
              • data.assets.data.tags.meta.per_page integer
              • data.assets.data.tags.meta.to integer
              • data.assets.data.tags.meta.total integer
            • data.assets.data.tags.links object
              • data.assets.data.tags.links.first string
              • data.assets.data.tags.links.last string
              • data.assets.data.tags.links.prev string
              • data.assets.data.tags.links.next string
      • data.primary_asset object
        • data.primary_asset.data object
          • data.primary_asset.data.id string
          • data.primary_asset.data.title string
          • data.primary_asset.data.type string
          • data.primary_asset.data.caption string
          • data.primary_asset.data.kind string
          • data.primary_asset.data.external boolean
          • data.primary_asset.data.position integer
          • data.primary_asset.data.primary boolean
          • data.primary_asset.data.url string
          • data.primary_asset.data.sub_kind string
          • data.primary_asset.data.extension string
          • data.primary_asset.data.original_filename string
          • data.primary_asset.data.size string
          • data.primary_asset.data.width string
          • data.primary_asset.data.height string
          • data.primary_asset.data.transforms object
            • data.primary_asset.data.transforms.data array[object]
              • data.primary_asset.data.transforms.data.id string
              • data.primary_asset.data.transforms.data.handle string
              • data.primary_asset.data.transforms.data.url string
            • data.primary_asset.data.transforms.meta object
              • data.primary_asset.data.transforms.meta.current_page integer(int32)
              • data.primary_asset.data.transforms.meta.from integer
              • data.primary_asset.data.transforms.meta.last_page integer
              • data.primary_asset.data.transforms.meta.path string
              • data.primary_asset.data.transforms.meta.per_page integer
              • data.primary_asset.data.transforms.meta.to integer
              • data.primary_asset.data.transforms.meta.total integer
            • data.primary_asset.data.transforms.links object
              • data.primary_asset.data.transforms.links.first string
              • data.primary_asset.data.transforms.links.last string
              • data.primary_asset.data.transforms.links.prev string
              • data.primary_asset.data.transforms.links.next string
          • data.primary_asset.data.tags object
            • data.primary_asset.data.tags.data array[object]
              • data.primary_asset.data.tags.data.id string
              • data.primary_asset.data.tags.data.name string
            • data.primary_asset.data.tags.meta object
              • data.primary_asset.data.tags.meta.current_page integer(int32)
              • data.primary_asset.data.tags.meta.from integer
              • data.primary_asset.data.tags.meta.last_page integer
              • data.primary_asset.data.tags.meta.path string
              • data.primary_asset.data.tags.meta.per_page integer
              • data.primary_asset.data.tags.meta.to integer
              • data.primary_asset.data.tags.meta.total integer
            • data.primary_asset.data.tags.links object
              • data.primary_asset.data.tags.links.first string
              • data.primary_asset.data.tags.links.last string
              • data.primary_asset.data.tags.links.prev string
              • data.primary_asset.data.tags.links.next string
      • data.attributes object
        • data.attributes.data array[object]
          • data.attributes.data.id string
          • data.attributes.data.name object
          • data.attributes.data.handle string
          • data.attributes.data.position integer
          • data.attributes.data.filterable boolean
          • data.attributes.data.scopeable boolean
          • data.attributes.data.translatable boolean
          • data.attributes.data.variant boolean
          • data.attributes.data.searchable boolean
          • data.attributes.data.localised boolean
          • data.attributes.data.type string
          • data.attributes.data.required boolean
          • data.attributes.data.lookups array[object]
          • data.attributes.data.system boolean
          • data.attributes.data.group object
            • data.attributes.data.group.data object
              Available includes
              • attributes
              • data.attributes.data.group.data.id string
              • data.attributes.data.group.data.name object
              • data.attributes.data.group.data.handle string
              • data.attributes.data.group.data.position integer(int32)
              • data.attributes.data.group.data.
        • data.attributes.meta object
          • data.attributes.meta.current_page integer(int32)
          • data.attributes.meta.from integer
          • data.attributes.meta.last_page integer
          • data.attributes.meta.path string
          • data.attributes.meta.per_page integer
          • data.attributes.meta.to integer
          • data.attributes.meta.total integer
        • data.attributes.links object
          • data.attributes.links.first string
          • data.attributes.links.last string
          • data.attributes.links.prev string
          • data.attributes.links.next string
      • data.customer_groups object
        • data.customer_groups.data array[object]
          • data.customer_groups.data.id string
          • data.customer_groups.data.name string
          • data.customer_groups.data.handle string
          • data.customer_groups.data.visible string
          • data.customer_groups.data.purchasable boolean
        • data.customer_groups.meta object
          • data.customer_groups.meta.current_page integer(int32)
          • data.customer_groups.meta.from integer
          • data.customer_groups.meta.last_page integer
          • data.customer_groups.meta.path string
          • data.customer_groups.meta.per_page integer
          • data.customer_groups.meta.to integer
          • data.customer_groups.meta.total integer
        • data.customer_groups.links object
          • data.customer_groups.links.first string
          • data.customer_groups.links.last string
          • data.customer_groups.links.prev string
          • data.customer_groups.links.next string
      • data.products object
        • data.products.data array[]
        • data.products.meta object
          • data.products.meta.current_page integer(int32)
          • data.products.meta.from integer
          • data.products.meta.last_page integer
          • data.products.meta.path string
          • data.products.meta.per_page integer
          • data.products.meta.to integer
          • data.products.meta.total integer
        • data.products.links object
          • data.products.links.first string
          • data.products.links.last string
          • data.products.links.prev string
          • data.products.links.next string
Definition
GET http://localhost:3000/api/v1/categories/{categoryId}
cURL example
curl \ -X GET http://localhost:3000/api/v1/categories/{categoryId} \ -H "Content-Type: application/json"
Response example (200)
{ "data": { "primary_asset": { "data": { "extension": "extension", "kind": "kind", "caption": "caption", "title": "title", "type": "type", "url": "url", "external": true, "original_filename": "original_filename", "size": "size", "width": "width", "id": "id", "position": 5, "sub_kind": "sub_kind", "primary": true, "height": "height" } }, "children_count": 6, "products_count": 0, "sort": "sort", "left_pos": 1, "right_pos": 5, "layout": { "data": { "name": "name", "handle": "handle", "id": "id", "type": "type" } }, "assets": { "data": [ { "extension": "extension", "kind": "kind", "caption": "caption", "title": "title", "type": "type", "url": "url", "external": true, "original_filename": "original_filename", "size": "size", "width": "width", "id": "id", "position": 5, "sub_kind": "sub_kind", "primary": true, "height": "height" }, { "extension": "extension", "kind": "kind", "caption": "caption", "title": "title", "type": "type", "url": "url", "external": true, "original_filename": "original_filename", "size": "size", "width": "width", "id": "id", "position": 5, "sub_kind": "sub_kind", "primary": true, "height": "height" } ] }, "name": "name", "id": "id", "attribute_data": "{}" } }

Update a category

Update a category using a given ID.

URL parameters
  • categoryId Required / string
Body
  • attributes Required / object
Responses
  • 200 object

    OK

    • data object
      Available includes
      • children
      • data.id string
      • data.sort string
      • data.products_count integer
      • data.children_count integer
      • data.left_pos integer
      • data.right_pos integer
      • data.name string
      • data.attribute_data object
      • data.
      • data.channels object
        • data.channels.data array[object]
          • data.channels.data.id string
          • data.channels.data.name string
          • data.channels.data.handle string
          • data.channels.data.url string(uri)
          • data.channels.data.default boolean
        • data.channels.current_page integer(int32)
        • data.channels.from integer
        • data.channels.last_page integer
        • data.channels.path string
        • data.channels.per_page integer
        • data.channels.to integer
        • data.channels.total integer
      • data.
      • data.routes object
        • data.routes.data array[object]
          • data.routes.data.id string
          • data.routes.data.default boolean
          • data.routes.data.redirect boolean
          • data.routes.data.locale string
          • data.routes.data.path string
          • data.routes.data.slug string
          • data.routes.data.description string
          • data.routes.data.type string
          • data.routes.data.element object
            • data.routes.data.element.data object
              • data.routes.data.element.data.id string
        • data.routes.meta object
          • data.routes.meta.current_page integer(int32)
          • data.routes.meta.from integer
          • data.routes.meta.last_page integer
          • data.routes.meta.path string
          • data.routes.meta.per_page integer
          • data.routes.meta.to integer
          • data.routes.meta.total integer
        • data.routes.links object
          • data.routes.links.first string
          • data.routes.links.last string
          • data.routes.links.prev string
          • data.routes.links.next string
      • data.layout object
        • data.layout.data object
          • data.layout.data.id Required / string
          • data.layout.data.name Required / string
          • data.layout.data.handle Required / string
          • data.layout.data.type Required / string
      • data.assets object
        • data.assets.data array[object]
          • data.assets.data.id string
          • data.assets.data.title string
          • data.assets.data.type string
          • data.assets.data.caption string
          • data.assets.data.kind string
          • data.assets.data.external boolean
          • data.assets.data.position integer
          • data.assets.data.primary boolean
          • data.assets.data.url string
          • data.assets.data.sub_kind string
          • data.assets.data.extension string
          • data.assets.data.original_filename string
          • data.assets.data.size string
          • data.assets.data.width string
          • data.assets.data.height string
          • data.assets.data.transforms object
            • data.assets.data.transforms.data array[object]
              • data.assets.data.transforms.data.id string
              • data.assets.data.transforms.data.handle string
              • data.assets.data.transforms.data.url string
            • data.assets.data.transforms.meta object
              • data.assets.data.transforms.meta.current_page integer(int32)
              • data.assets.data.transforms.meta.from integer
              • data.assets.data.transforms.meta.last_page integer
              • data.assets.data.transforms.meta.path string
              • data.assets.data.transforms.meta.per_page integer
              • data.assets.data.transforms.meta.to integer
              • data.assets.data.transforms.meta.total integer
            • data.assets.data.transforms.links object
              • data.assets.data.transforms.links.first string
              • data.assets.data.transforms.links.last string
              • data.assets.data.transforms.links.prev string
              • data.assets.data.transforms.links.next string
          • data.assets.data.tags object
            • data.assets.data.tags.data array[object]
              • data.assets.data.tags.data.id string
              • data.assets.data.tags.data.name string
            • data.assets.data.tags.meta object
              • data.assets.data.tags.meta.current_page integer(int32)
              • data.assets.data.tags.meta.from integer
              • data.assets.data.tags.meta.last_page integer
              • data.assets.data.tags.meta.path string
              • data.assets.data.tags.meta.per_page integer
              • data.assets.data.tags.meta.to integer
              • data.assets.data.tags.meta.total integer
            • data.assets.data.tags.links object
              • data.assets.data.tags.links.first string
              • data.assets.data.tags.links.last string
              • data.assets.data.tags.links.prev string
              • data.assets.data.tags.links.next string
      • data.primary_asset object
        • data.primary_asset.data object
          • data.primary_asset.data.id string
          • data.primary_asset.data.title string
          • data.primary_asset.data.type string
          • data.primary_asset.data.caption string
          • data.primary_asset.data.kind string
          • data.primary_asset.data.external boolean
          • data.primary_asset.data.position integer
          • data.primary_asset.data.primary boolean
          • data.primary_asset.data.url string
          • data.primary_asset.data.sub_kind string
          • data.primary_asset.data.extension string
          • data.primary_asset.data.original_filename string
          • data.primary_asset.data.size string
          • data.primary_asset.data.width string
          • data.primary_asset.data.height string
          • data.primary_asset.data.transforms object
            • data.primary_asset.data.transforms.data array[object]
              • data.primary_asset.data.transforms.data.id string
              • data.primary_asset.data.transforms.data.handle string
              • data.primary_asset.data.transforms.data.url string
            • data.primary_asset.data.transforms.meta object
              • data.primary_asset.data.transforms.meta.current_page integer(int32)
              • data.primary_asset.data.transforms.meta.from integer
              • data.primary_asset.data.transforms.meta.last_page integer
              • data.primary_asset.data.transforms.meta.path string
              • data.primary_asset.data.transforms.meta.per_page integer
              • data.primary_asset.data.transforms.meta.to integer
              • data.primary_asset.data.transforms.meta.total integer
            • data.primary_asset.data.transforms.links object
              • data.primary_asset.data.transforms.links.first string
              • data.primary_asset.data.transforms.links.last string
              • data.primary_asset.data.transforms.links.prev string
              • data.primary_asset.data.transforms.links.next string
          • data.primary_asset.data.tags object
            • data.primary_asset.data.tags.data array[object]
              • data.primary_asset.data.tags.data.id string
              • data.primary_asset.data.tags.data.name string
            • data.primary_asset.data.tags.meta object
              • data.primary_asset.data.tags.meta.current_page integer(int32)
              • data.primary_asset.data.tags.meta.from integer
              • data.primary_asset.data.tags.meta.last_page integer
              • data.primary_asset.data.tags.meta.path string
              • data.primary_asset.data.tags.meta.per_page integer
              • data.primary_asset.data.tags.meta.to integer
              • data.primary_asset.data.tags.meta.total integer
            • data.primary_asset.data.tags.links object
              • data.primary_asset.data.tags.links.first string
              • data.primary_asset.data.tags.links.last string
              • data.primary_asset.data.tags.links.prev string
              • data.primary_asset.data.tags.links.next string
      • data.attributes object
        • data.attributes.data array[object]
          • data.attributes.data.id string
          • data.attributes.data.name object
          • data.attributes.data.handle string
          • data.attributes.data.position integer
          • data.attributes.data.filterable boolean
          • data.attributes.data.scopeable boolean
          • data.attributes.data.translatable boolean
          • data.attributes.data.variant boolean
          • data.attributes.data.searchable boolean
          • data.attributes.data.localised boolean
          • data.attributes.data.type string
          • data.attributes.data.required boolean
          • data.attributes.data.lookups array[object]
          • data.attributes.data.system boolean
          • data.attributes.data.group object
            • data.attributes.data.group.data object
              Available includes
              • attributes
              • data.attributes.data.group.data.id string
              • data.attributes.data.group.data.name object
              • data.attributes.data.group.data.handle string
              • data.attributes.data.group.data.position integer(int32)
              • data.attributes.data.group.data.
        • data.attributes.meta object
          • data.attributes.meta.current_page integer(int32)
          • data.attributes.meta.from integer
          • data.attributes.meta.last_page integer
          • data.attributes.meta.path string
          • data.attributes.meta.per_page integer
          • data.attributes.meta.to integer
          • data.attributes.meta.total integer
        • data.attributes.links object
          • data.attributes.links.first string
          • data.attributes.links.last string
          • data.attributes.links.prev string
          • data.attributes.links.next string
      • data.customer_groups object
        • data.customer_groups.data array[object]
          • data.customer_groups.data.id string
          • data.customer_groups.data.name string
          • data.customer_groups.data.handle string
          • data.customer_groups.data.visible string
          • data.customer_groups.data.purchasable boolean
        • data.customer_groups.meta object
          • data.customer_groups.meta.current_page integer(int32)
          • data.customer_groups.meta.from integer
          • data.customer_groups.meta.last_page integer
          • data.customer_groups.meta.path string
          • data.customer_groups.meta.per_page integer
          • data.customer_groups.meta.to integer
          • data.customer_groups.meta.total integer
        • data.customer_groups.links object
          • data.customer_groups.links.first string
          • data.customer_groups.links.last string
          • data.customer_groups.links.prev string
          • data.customer_groups.links.next string
      • data.products object
        • data.products.data array[]
        • data.products.meta object
          • data.products.meta.current_page integer(int32)
          • data.products.meta.from integer
          • data.products.meta.last_page integer
          • data.products.meta.path string
          • data.products.meta.per_page integer
          • data.products.meta.to integer
          • data.products.meta.total integer
        • data.products.links object
          • data.products.links.first string
          • data.products.links.last string
          • data.products.links.prev string
          • data.products.links.next string
  • 404 object

    Not Found

    • error object
      • error.http_code integer
      • error.message string
  • 422

    Unprocessable Entity

Definition
PUT http://localhost:3000/api/v1/categories/{categoryId}
cURL example
curl \ -X PUT http://localhost:3000/api/v1/categories/{categoryId} \ -H "Content-Type: application/json" \ -d '{"attributes":{}}'
Request payload example
{ "attributes": { } }
Response example (200)
{ "data": { "primary_asset": { "data": { "extension": "extension", "kind": "kind", "caption": "caption", "title": "title", "type": "type", "url": "url", "external": true, "original_filename": "original_filename", "size": "size", "width": "width", "id": "id", "position": 5, "sub_kind": "sub_kind", "primary": true, "height": "height" } }, "children_count": 6, "products_count": 0, "sort": "sort", "left_pos": 1, "right_pos": 5, "layout": { "data": { "name": "name", "handle": "handle", "id": "id", "type": "type" } }, "assets": { "data": [ { "extension": "extension", "kind": "kind", "caption": "caption", "title": "title", "type": "type", "url": "url", "external": true, "original_filename": "original_filename", "size": "size", "width": "width", "id": "id", "position": 5, "sub_kind": "sub_kind", "primary": true, "height": "height" }, { "extension": "extension", "kind": "kind", "caption": "caption", "title": "title", "type": "type", "url": "url", "external": true, "original_filename": "original_filename", "size": "size", "width": "width", "id": "id", "position": 5, "sub_kind": "sub_kind", "primary": true, "height": "height" } ] }, "name": "name", "id": "id", "attribute_data": "{}" } }
Response example (404)
{ "error": { "http_code": 404, "message": "Resource not found" } }
Response example (422)
No content

Get categories by parent id

Returns categories by a given parent ID.

URL parameters
  • parentId Required / string

    If omitted will return top level catgories

  • include string
Responses
  • 200 object

    OK

    • data array[object]
      • data.id string
      • data.sort string
      • data.products_count integer
      • data.children_count integer
      • data.left_pos integer
      • data.right_pos integer
      • data.name string
      • data.attribute_data object
      • data.
      • data.channels object
        • data.channels.data array[object]
          • data.channels.data.id string
          • data.channels.data.name string
          • data.channels.data.handle string
          • data.channels.data.url string(uri)
          • data.channels.data.default boolean
        • data.channels.current_page integer(int32)
        • data.channels.from integer
        • data.channels.last_page integer
        • data.channels.path string
        • data.channels.per_page integer
        • data.channels.to integer
        • data.channels.total integer
      • data.
      • data.routes object
        • data.routes.data array[object]
          • data.routes.data.id string
          • data.routes.data.default boolean
          • data.routes.data.redirect boolean
          • data.routes.data.locale string
          • data.routes.data.path string
          • data.routes.data.slug string
          • data.routes.data.description string
          • data.routes.data.type string
          • data.routes.data.element object
            • data.routes.data.element.data object
              • data.routes.data.element.data.id string
        • data.routes.meta object
          • data.routes.meta.current_page integer(int32)
          • data.routes.meta.from integer
          • data.routes.meta.last_page integer
          • data.routes.meta.path string
          • data.routes.meta.per_page integer
          • data.routes.meta.to integer
          • data.routes.meta.total integer
        • data.routes.links object
          • data.routes.links.first string
          • data.routes.links.last string
          • data.routes.links.prev string
          • data.routes.links.next string
      • data.layout object
        • data.layout.data object
          • data.layout.data.id Required / string
          • data.layout.data.name Required / string
          • data.layout.data.handle Required / string
          • data.layout.data.type Required / string
      • data.assets object
        • data.assets.data array[object]
          • data.assets.data.id string
          • data.assets.data.title string
          • data.assets.data.type string
          • data.assets.data.caption string
          • data.assets.data.kind string
          • data.assets.data.external boolean
          • data.assets.data.position integer
          • data.assets.data.primary boolean
          • data.assets.data.url string
          • data.assets.data.sub_kind string
          • data.assets.data.extension string
          • data.assets.data.original_filename string
          • data.assets.data.size string
          • data.assets.data.width string
          • data.assets.data.height string
          • data.assets.data.transforms object
            • data.assets.data.transforms.data array[object]
              • data.assets.data.transforms.data.id string
              • data.assets.data.transforms.data.handle string
              • data.assets.data.transforms.data.url string
            • data.assets.data.transforms.meta object
              • data.assets.data.transforms.meta.current_page integer(int32)
              • data.assets.data.transforms.meta.from integer
              • data.assets.data.transforms.meta.last_page integer
              • data.assets.data.transforms.meta.path string
              • data.assets.data.transforms.meta.per_page integer
              • data.assets.data.transforms.meta.to integer
              • data.assets.data.transforms.meta.total integer
            • data.assets.data.transforms.links object
              • data.assets.data.transforms.links.first string
              • data.assets.data.transforms.links.last string
              • data.assets.data.transforms.links.prev string
              • data.assets.data.transforms.links.next string
          • data.assets.data.tags object
            • data.assets.data.tags.data array[object]
              • data.assets.data.tags.data.id string
              • data.assets.data.tags.data.name string
            • data.assets.data.tags.meta object
              • data.assets.data.tags.meta.current_page integer(int32)
              • data.assets.data.tags.meta.from integer
              • data.assets.data.tags.meta.last_page integer
              • data.assets.data.tags.meta.path string
              • data.assets.data.tags.meta.per_page integer
              • data.assets.data.tags.meta.to integer
              • data.assets.data.tags.meta.total integer
            • data.assets.data.tags.links object
              • data.assets.data.tags.links.first string
              • data.assets.data.tags.links.last string
              • data.assets.data.tags.links.prev string
              • data.assets.data.tags.links.next string
      • data.primary_asset object
        • data.primary_asset.data object
          • data.primary_asset.data.id string
          • data.primary_asset.data.title string
          • data.primary_asset.data.type string
          • data.primary_asset.data.caption string
          • data.primary_asset.data.kind string
          • data.primary_asset.data.external boolean
          • data.primary_asset.data.position integer
          • data.primary_asset.data.primary boolean
          • data.primary_asset.data.url string
          • data.primary_asset.data.sub_kind string
          • data.primary_asset.data.extension string
          • data.primary_asset.data.original_filename string
          • data.primary_asset.data.size string
          • data.primary_asset.data.width string
          • data.primary_asset.data.height string
          • data.primary_asset.data.transforms object
            • data.primary_asset.data.transforms.data array[object]
              • data.primary_asset.data.transforms.data.id string
              • data.primary_asset.data.transforms.data.handle string
              • data.primary_asset.data.transforms.data.url string
            • data.primary_asset.data.transforms.meta object
              • data.primary_asset.data.transforms.meta.current_page integer(int32)
              • data.primary_asset.data.transforms.meta.from integer
              • data.primary_asset.data.transforms.meta.last_page integer
              • data.primary_asset.data.transforms.meta.path string
              • data.primary_asset.data.transforms.meta.per_page integer
              • data.primary_asset.data.transforms.meta.to integer
              • data.primary_asset.data.transforms.meta.total integer
            • data.primary_asset.data.transforms.links object
              • data.primary_asset.data.transforms.links.first string
              • data.primary_asset.data.transforms.links.last string
              • data.primary_asset.data.transforms.links.prev string
              • data.primary_asset.data.transforms.links.next string
          • data.primary_asset.data.tags object
            • data.primary_asset.data.tags.data array[object]
              • data.primary_asset.data.tags.data.id string
              • data.primary_asset.data.tags.data.name string
            • data.primary_asset.data.tags.meta object
              • data.primary_asset.data.tags.meta.current_page integer(int32)
              • data.primary_asset.data.tags.meta.from integer
              • data.primary_asset.data.tags.meta.last_page integer
              • data.primary_asset.data.tags.meta.path string
              • data.primary_asset.data.tags.meta.per_page integer
              • data.primary_asset.data.tags.meta.to integer
              • data.primary_asset.data.tags.meta.total integer
            • data.primary_asset.data.tags.links object
              • data.primary_asset.data.tags.links.first string
              • data.primary_asset.data.tags.links.last string
              • data.primary_asset.data.tags.links.prev string
              • data.primary_asset.data.tags.links.next string
      • data.attributes object
        • data.attributes.data array[object]
          • data.attributes.data.id string
          • data.attributes.data.name object
          • data.attributes.data.handle string
          • data.attributes.data.position integer
          • data.attributes.data.filterable boolean
          • data.attributes.data.scopeable boolean
          • data.attributes.data.translatable boolean
          • data.attributes.data.variant boolean
          • data.attributes.data.searchable boolean
          • data.attributes.data.localised boolean
          • data.attributes.data.type string
          • data.attributes.data.required boolean
          • data.attributes.data.lookups array[object]
          • data.attributes.data.system boolean
          • data.attributes.data.group object
            • data.attributes.data.group.data object
              Available includes
              • attributes
              • data.attributes.data.group.data.id string
              • data.attributes.data.group.data.name object
              • data.attributes.data.group.data.handle string
              • data.attributes.data.group.data.position integer(int32)
              • data.attributes.data.group.data.
        • data.attributes.meta object
          • data.attributes.meta.current_page integer(int32)
          • data.attributes.meta.from integer
          • data.attributes.meta.last_page integer
          • data.attributes.meta.path string
          • data.attributes.meta.per_page integer
          • data.attributes.meta.to integer
          • data.attributes.meta.total integer
        • data.attributes.links object
          • data.attributes.links.first string
          • data.attributes.links.last string
          • data.attributes.links.prev string
          • data.attributes.links.next string
      • data.customer_groups object
        • data.customer_groups.data array[object]
          • data.customer_groups.data.id string
          • data.customer_groups.data.name string
          • data.customer_groups.data.handle string
          • data.customer_groups.data.visible string
          • data.customer_groups.data.purchasable boolean
        • data.customer_groups.meta object
          • data.customer_groups.meta.current_page integer(int32)
          • data.customer_groups.meta.from integer
          • data.customer_groups.meta.last_page integer
          • data.customer_groups.meta.path string
          • data.customer_groups.meta.per_page integer
          • data.customer_groups.meta.to integer
          • data.customer_groups.meta.total integer
        • data.customer_groups.links object
          • data.customer_groups.links.first string
          • data.customer_groups.links.last string
          • data.customer_groups.links.prev string
          • data.customer_groups.links.next string
      • data.products object
        • data.products.data array[]
        • data.products.meta object
          • data.products.meta.current_page integer(int32)
          • data.products.meta.from integer
          • data.products.meta.last_page integer
          • data.products.meta.path string
          • data.products.meta.per_page integer
          • data.products.meta.to integer
          • data.products.meta.total integer
        • data.products.links object
          • data.products.links.first string
          • data.products.links.last string
          • data.products.links.prev string
          • data.products.links.next string
    • meta object
      • meta.current_page integer(int32)
      • meta.from integer
      • meta.last_page integer
      • meta.path string
      • meta.per_page integer
      • meta.to integer
      • meta.total integer
    • links object
      • links.first string
      • links.last string
      • links.prev string
      • links.next string
Definition
GET http://localhost:3000/api/v1/categories/parent/{parentId}
cURL example
curl \ -X GET http://localhost:3000/api/v1/categories/parent/{parentId} \ -H "Content-Type: application/json"
Response example (200)
{ "data": [ { "primary_asset": { "data": { "extension": "extension", "kind": "kind", "caption": "caption", "title": "title", "type": "type", "url": "url", "external": true, "original_filename": "original_filename", "size": "size", "width": "width", "id": "id", "position": 5, "sub_kind": "sub_kind", "primary": true, "height": "height" } }, "children_count": 6, "products_count": 0, "sort": "sort", "left_pos": 1, "right_pos": 5, "layout": { "data": { "name": "name", "handle": "handle", "id": "id", "type": "type" } }, "assets": { "data": [ { "extension": "extension", "kind": "kind", "caption": "caption", "title": "title", "type": "type", "url": "url", "external": true, "original_filename": "original_filename", "size": "size", "width": "width", "id": "id", "position": 5, "sub_kind": "sub_kind", "primary": true, "height": "height" }, { "extension": "extension", "kind": "kind", "caption": "caption", "title": "title", "type": "type", "url": "url", "external": true, "original_filename": "original_filename", "size": "size", "width": "width", "id": "id", "position": 5, "sub_kind": "sub_kind", "primary": true, "height": "height" } ] }, "name": "name", "id": "id", "attribute_data": "{}" } ], "meta": { "current_page": 1, "from": 24, "last_page": 15, "path": "string", "per_page": 1, "to": 42, "total": 42 }, "links": { "next": "next", "last": "last", "prev": "prev", "first": "first" } }

Reorder a category

Body
  • action string

    before, after, over

  • moved_node Required / string

    The ID of the category which moved

  • node Required / string

    The id of the category affected

Responses
  • 200 object

    OK

    • message string
  • 404 object

    Not Found

    • error object
      • error.http_code integer
      • error.message string
Definition
POST http://localhost:3000/api/v1/categories/reorder
cURL example
curl \ -X POST http://localhost:3000/api/v1/categories/reorder \ -H "Content-Type: application/json" \ -d '{"action":"string","moved_node":"string","node":"string"}'
Request payload example
{ "action": "string", "moved_node": "string", "node": "string" }
Response example (200)
{ "status": "success" }
Response example (404)
{ "error": { "http_code": 404, "message": "Resource not found" } }

Attach products

Attaches products to a category resource.

URL parameters
  • categoryId Required / string
Body
  • products array[object]
    • products.id string
    • products.position integer(int32)
  • sort_type string

    custom, min_price:asc, min_price:desc, sku:asc, sku:desc

Responses
  • 200 object

    OK

    • data object
      Available includes
      • children
      • data.id string
      • data.sort string
      • data.products_count integer
      • data.children_count integer
      • data.left_pos integer
      • data.right_pos integer
      • data.name string
      • data.attribute_data object
      • data.
      • data.channels object
        • data.channels.data array[object]
          • data.channels.data.id string
          • data.channels.data.name string
          • data.channels.data.handle string
          • data.channels.data.url string(uri)
          • data.channels.data.default boolean
        • data.channels.current_page integer(int32)
        • data.channels.from integer
        • data.channels.last_page integer
        • data.channels.path string
        • data.channels.per_page integer
        • data.channels.to integer
        • data.channels.total integer
      • data.
      • data.routes object
        • data.routes.data array[object]
          • data.routes.data.id string
          • data.routes.data.default boolean
          • data.routes.data.redirect boolean
          • data.routes.data.locale string
          • data.routes.data.path string
          • data.routes.data.slug string
          • data.routes.data.description string
          • data.routes.data.type string
          • data.routes.data.element object
            • data.routes.data.element.data object
              • data.routes.data.element.data.id string
        • data.routes.meta object
          • data.routes.meta.current_page integer(int32)
          • data.routes.meta.from integer
          • data.routes.meta.last_page integer
          • data.routes.meta.path string
          • data.routes.meta.per_page integer
          • data.routes.meta.to integer
          • data.routes.meta.total integer
        • data.routes.links object
          • data.routes.links.first string
          • data.routes.links.last string
          • data.routes.links.prev string
          • data.routes.links.next string
      • data.layout object
        • data.layout.data object
          • data.layout.data.id Required / string
          • data.layout.data.name Required / string
          • data.layout.data.handle Required / string
          • data.layout.data.type Required / string
      • data.assets object
        • data.assets.data array[object]
          • data.assets.data.id string
          • data.assets.data.title string
          • data.assets.data.type string
          • data.assets.data.caption string
          • data.assets.data.kind string
          • data.assets.data.external boolean
          • data.assets.data.position integer
          • data.assets.data.primary boolean
          • data.assets.data.url string
          • data.assets.data.sub_kind string
          • data.assets.data.extension string
          • data.assets.data.original_filename string
          • data.assets.data.size string
          • data.assets.data.width string
          • data.assets.data.height string
          • data.assets.data.transforms object
            • data.assets.data.transforms.data array[object]
              • data.assets.data.transforms.data.id string
              • data.assets.data.transforms.data.handle string
              • data.assets.data.transforms.data.url string
            • data.assets.data.transforms.meta object
              • data.assets.data.transforms.meta.current_page integer(int32)
              • data.assets.data.transforms.meta.from integer
              • data.assets.data.transforms.meta.last_page integer
              • data.assets.data.transforms.meta.path string
              • data.assets.data.transforms.meta.per_page integer
              • data.assets.data.transforms.meta.to integer
              • data.assets.data.transforms.meta.total integer
            • data.assets.data.transforms.links object
              • data.assets.data.transforms.links.first string
              • data.assets.data.transforms.links.last string
              • data.assets.data.transforms.links.prev string
              • data.assets.data.transforms.links.next string
          • data.assets.data.tags object
            • data.assets.data.tags.data array[object]
              • data.assets.data.tags.data.id string
              • data.assets.data.tags.data.name string
            • data.assets.data.tags.meta object
              • data.assets.data.tags.meta.current_page integer(int32)
              • data.assets.data.tags.meta.from integer
              • data.assets.data.tags.meta.last_page integer
              • data.assets.data.tags.meta.path string
              • data.assets.data.tags.meta.per_page integer
              • data.assets.data.tags.meta.to integer
              • data.assets.data.tags.meta.total integer
            • data.assets.data.tags.links object
              • data.assets.data.tags.links.first string
              • data.assets.data.tags.links.last string
              • data.assets.data.tags.links.prev string
              • data.assets.data.tags.links.next string
      • data.primary_asset object
        • data.primary_asset.data object
          • data.primary_asset.data.id string
          • data.primary_asset.data.title string
          • data.primary_asset.data.type string
          • data.primary_asset.data.caption string
          • data.primary_asset.data.kind string
          • data.primary_asset.data.external boolean
          • data.primary_asset.data.position integer
          • data.primary_asset.data.primary boolean
          • data.primary_asset.data.url string
          • data.primary_asset.data.sub_kind string
          • data.primary_asset.data.extension string
          • data.primary_asset.data.original_filename string
          • data.primary_asset.data.size string
          • data.primary_asset.data.width string
          • data.primary_asset.data.height string
          • data.primary_asset.data.transforms object
            • data.primary_asset.data.transforms.data array[object]
              • data.primary_asset.data.transforms.data.id string
              • data.primary_asset.data.transforms.data.handle string
              • data.primary_asset.data.transforms.data.url string
            • data.primary_asset.data.transforms.meta object
              • data.primary_asset.data.transforms.meta.current_page integer(int32)
              • data.primary_asset.data.transforms.meta.from integer
              • data.primary_asset.data.transforms.meta.last_page integer
              • data.primary_asset.data.transforms.meta.path string
              • data.primary_asset.data.transforms.meta.per_page integer
              • data.primary_asset.data.transforms.meta.to integer
              • data.primary_asset.data.transforms.meta.total integer
            • data.primary_asset.data.transforms.links object
              • data.primary_asset.data.transforms.links.first string
              • data.primary_asset.data.transforms.links.last string
              • data.primary_asset.data.transforms.links.prev string
              • data.primary_asset.data.transforms.links.next string
          • data.primary_asset.data.tags object
            • data.primary_asset.data.tags.data array[object]
              • data.primary_asset.data.tags.data.id string
              • data.primary_asset.data.tags.data.name string
            • data.primary_asset.data.tags.meta object
              • data.primary_asset.data.tags.meta.current_page integer(int32)
              • data.primary_asset.data.tags.meta.from integer
              • data.primary_asset.data.tags.meta.last_page integer
              • data.primary_asset.data.tags.meta.path string
              • data.primary_asset.data.tags.meta.per_page integer
              • data.primary_asset.data.tags.meta.to integer
              • data.primary_asset.data.tags.meta.total integer
            • data.primary_asset.data.tags.links object
              • data.primary_asset.data.tags.links.first string
              • data.primary_asset.data.tags.links.last string
              • data.primary_asset.data.tags.links.prev string
              • data.primary_asset.data.tags.links.next string
      • data.attributes object
        • data.attributes.data array[object]
          • data.attributes.data.id string
          • data.attributes.data.name object
          • data.attributes.data.handle string
          • data.attributes.data.position integer
          • data.attributes.data.filterable boolean
          • data.attributes.data.scopeable boolean
          • data.attributes.data.translatable boolean
          • data.attributes.data.variant boolean
          • data.attributes.data.searchable boolean
          • data.attributes.data.localised boolean
          • data.attributes.data.type string
          • data.attributes.data.required boolean
          • data.attributes.data.lookups array[object]
          • data.attributes.data.system boolean
          • data.attributes.data.group object
            • data.attributes.data.group.data object
              Available includes
              • attributes
              • data.attributes.data.group.data.id string
              • data.attributes.data.group.data.name object
              • data.attributes.data.group.data.handle string
              • data.attributes.data.group.data.position integer(int32)
              • data.attributes.data.group.data.
        • data.attributes.meta object
          • data.attributes.meta.current_page integer(int32)
          • data.attributes.meta.from integer
          • data.attributes.meta.last_page integer
          • data.attributes.meta.path string
          • data.attributes.meta.per_page integer
          • data.attributes.meta.to integer
          • data.attributes.meta.total integer
        • data.attributes.links object
          • data.attributes.links.first string
          • data.attributes.links.last string
          • data.attributes.links.prev string
          • data.attributes.links.next string
      • data.customer_groups object
        • data.customer_groups.data array[object]
          • data.customer_groups.data.id string
          • data.customer_groups.data.name string
          • data.customer_groups.data.handle string
          • data.customer_groups.data.visible string
          • data.customer_groups.data.purchasable boolean
        • data.customer_groups.meta object
          • data.customer_groups.meta.current_page integer(int32)
          • data.customer_groups.meta.from integer
          • data.customer_groups.meta.last_page integer
          • data.customer_groups.meta.path string
          • data.customer_groups.meta.per_page integer
          • data.customer_groups.meta.to integer
          • data.customer_groups.meta.total integer
        • data.customer_groups.links object
          • data.customer_groups.links.first string
          • data.customer_groups.links.last string
          • data.customer_groups.links.prev string
          • data.customer_groups.links.next string
      • data.products object
        • data.products.data array[]
        • data.products.meta object
          • data.products.meta.current_page integer(int32)
          • data.products.meta.from integer
          • data.products.meta.last_page integer
          • data.products.meta.path string
          • data.products.meta.per_page integer
          • data.products.meta.to integer
          • data.products.meta.total integer
        • data.products.links object
          • data.products.links.first string
          • data.products.links.last string
          • data.products.links.prev string
          • data.products.links.next string
Definition
PUT http://localhost:3000/api/v1/categories/{categoryId}/products
cURL example
curl \ -X PUT http://localhost:3000/api/v1/categories/{categoryId}/products \ -H "Content-Type: application/json" \ -d '{"products":[{"id":"id","position":1}],"sort_type":"string"}'
Request payload example
{ "products": [ { "id": "id", "position": 1 } ], "sort_type": "string" }
Response example (200)
{ "data": { "primary_asset": { "data": { "extension": "extension", "kind": "kind", "caption": "caption", "title": "title", "type": "type", "url": "url", "external": true, "original_filename": "original_filename", "size": "size", "width": "width", "id": "id", "position": 5, "sub_kind": "sub_kind", "primary": true, "height": "height" } }, "children_count": 6, "products_count": 0, "sort": "sort", "left_pos": 1, "right_pos": 5, "layout": { "data": { "name": "name", "handle": "handle", "id": "id", "type": "type" } }, "assets": { "data": [ { "extension": "extension", "kind": "kind", "caption": "caption", "title": "title", "type": "type", "url": "url", "external": true, "original_filename": "original_filename", "size": "size", "width": "width", "id": "id", "position": 5, "sub_kind": "sub_kind", "primary": true, "height": "height" }, { "extension": "extension", "kind": "kind", "caption": "caption", "title": "title", "type": "type", "url": "url", "external": true, "original_filename": "original_filename", "size": "size", "width": "width", "id": "id", "position": 5, "sub_kind": "sub_kind", "primary": true, "height": "height" } ] }, "name": "name", "id": "id", "attribute_data": "{}" } }

Attach channels to a category

Attaches channels to a catagory

URL parameters
  • categoryId Required / string
Body
  • channels array[object]
    • channels.id Required / string
    • channels.published_at Required / string
Responses
  • 200 object

    OK

    • data object
      Available includes
      • children
      • data.id string
      • data.sort string
      • data.products_count integer
      • data.children_count integer
      • data.left_pos integer
      • data.right_pos integer
      • data.name string
      • data.attribute_data object
      • data.
      • data.channels object
        • data.channels.data array[object]
          • data.channels.data.id string
          • data.channels.data.name string
          • data.channels.data.handle string
          • data.channels.data.url string(uri)
          • data.channels.data.default boolean
        • data.channels.current_page integer(int32)
        • data.channels.from integer
        • data.channels.last_page integer
        • data.channels.path string
        • data.channels.per_page integer
        • data.channels.to integer
        • data.channels.total integer
      • data.
      • data.routes object
        • data.routes.data array[object]
          • data.routes.data.id string
          • data.routes.data.default boolean
          • data.routes.data.redirect boolean
          • data.routes.data.locale string
          • data.routes.data.path string
          • data.routes.data.slug string
          • data.routes.data.description string
          • data.routes.data.type string
          • data.routes.data.element object
            • data.routes.data.element.data object
              • data.routes.data.element.data.id string
        • data.routes.meta object
          • data.routes.meta.current_page integer(int32)
          • data.routes.meta.from integer
          • data.routes.meta.last_page integer
          • data.routes.meta.path string
          • data.routes.meta.per_page integer
          • data.routes.meta.to integer
          • data.routes.meta.total integer
        • data.routes.links object
          • data.routes.links.first string
          • data.routes.links.last string
          • data.routes.links.prev string
          • data.routes.links.next string
      • data.layout object
        • data.layout.data object
          • data.layout.data.id Required / string
          • data.layout.data.name Required / string
          • data.layout.data.handle Required / string
          • data.layout.data.type Required / string
      • data.assets object
        • data.assets.data array[object]
          • data.assets.data.id string
          • data.assets.data.title string
          • data.assets.data.type string
          • data.assets.data.caption string
          • data.assets.data.kind string
          • data.assets.data.external boolean
          • data.assets.data.position integer
          • data.assets.data.primary boolean
          • data.assets.data.url string
          • data.assets.data.sub_kind string
          • data.assets.data.extension string
          • data.assets.data.original_filename string
          • data.assets.data.size string
          • data.assets.data.width string
          • data.assets.data.height string
          • data.assets.data.transforms object
            • data.assets.data.transforms.data array[object]
              • data.assets.data.transforms.data.id string
              • data.assets.data.transforms.data.handle string
              • data.assets.data.transforms.data.url string
            • data.assets.data.transforms.meta object
              • data.assets.data.transforms.meta.current_page integer(int32)
              • data.assets.data.transforms.meta.from integer
              • data.assets.data.transforms.meta.last_page integer
              • data.assets.data.transforms.meta.path string
              • data.assets.data.transforms.meta.per_page integer
              • data.assets.data.transforms.meta.to integer
              • data.assets.data.transforms.meta.total integer
            • data.assets.data.transforms.links object
              • data.assets.data.transforms.links.first string
              • data.assets.data.transforms.links.last string
              • data.assets.data.transforms.links.prev string
              • data.assets.data.transforms.links.next string
          • data.assets.data.tags object
            • data.assets.data.tags.data array[object]
              • data.assets.data.tags.data.id string
              • data.assets.data.tags.data.name string
            • data.assets.data.tags.meta object
              • data.assets.data.tags.meta.current_page integer(int32)
              • data.assets.data.tags.meta.from integer
              • data.assets.data.tags.meta.last_page integer
              • data.assets.data.tags.meta.path string
              • data.assets.data.tags.meta.per_page integer
              • data.assets.data.tags.meta.to integer
              • data.assets.data.tags.meta.total integer
            • data.assets.data.tags.links object
              • data.assets.data.tags.links.first string
              • data.assets.data.tags.links.last string
              • data.assets.data.tags.links.prev string
              • data.assets.data.tags.links.next string
      • data.primary_asset object
        • data.primary_asset.data object
          • data.primary_asset.data.id string
          • data.primary_asset.data.title string
          • data.primary_asset.data.type string
          • data.primary_asset.data.caption string
          • data.primary_asset.data.kind string
          • data.primary_asset.data.external boolean
          • data.primary_asset.data.position integer
          • data.primary_asset.data.primary boolean
          • data.primary_asset.data.url string
          • data.primary_asset.data.sub_kind string
          • data.primary_asset.data.extension string
          • data.primary_asset.data.original_filename string
          • data.primary_asset.data.size string
          • data.primary_asset.data.width string
          • data.primary_asset.data.height string
          • data.primary_asset.data.transforms object
            • data.primary_asset.data.transforms.data array[object]
              • data.primary_asset.data.transforms.data.id string
              • data.primary_asset.data.transforms.data.handle string
              • data.primary_asset.data.transforms.data.url string
            • data.primary_asset.data.transforms.meta object
              • data.primary_asset.data.transforms.meta.current_page integer(int32)
              • data.primary_asset.data.transforms.meta.from integer
              • data.primary_asset.data.transforms.meta.last_page integer
              • data.primary_asset.data.transforms.meta.path string
              • data.primary_asset.data.transforms.meta.per_page integer
              • data.primary_asset.data.transforms.meta.to integer
              • data.primary_asset.data.transforms.meta.total integer
            • data.primary_asset.data.transforms.links object
              • data.primary_asset.data.transforms.links.first string
              • data.primary_asset.data.transforms.links.last string
              • data.primary_asset.data.transforms.links.prev string
              • data.primary_asset.data.transforms.links.next string
          • data.primary_asset.data.tags object
            • data.primary_asset.data.tags.data array[object]
              • data.primary_asset.data.tags.data.id string
              • data.primary_asset.data.tags.data.name string
            • data.primary_asset.data.tags.meta object
              • data.primary_asset.data.tags.meta.current_page integer(int32)
              • data.primary_asset.data.tags.meta.from integer
              • data.primary_asset.data.tags.meta.last_page integer
              • data.primary_asset.data.tags.meta.path string
              • data.primary_asset.data.tags.meta.per_page integer
              • data.primary_asset.data.tags.meta.to integer
              • data.primary_asset.data.tags.meta.total integer
            • data.primary_asset.data.tags.links object
              • data.primary_asset.data.tags.links.first string
              • data.primary_asset.data.tags.links.last string
              • data.primary_asset.data.tags.links.prev string
              • data.primary_asset.data.tags.links.next string
      • data.attributes object
        • data.attributes.data array[object]
          • data.attributes.data.id string
          • data.attributes.data.name object
          • data.attributes.data.handle string
          • data.attributes.data.position integer
          • data.attributes.data.filterable boolean
          • data.attributes.data.scopeable boolean
          • data.attributes.data.translatable boolean
          • data.attributes.data.variant boolean
          • data.attributes.data.searchable boolean
          • data.attributes.data.localised boolean
          • data.attributes.data.type string
          • data.attributes.data.required boolean
          • data.attributes.data.lookups array[object]
          • data.attributes.data.system boolean
          • data.attributes.data.group object
            • data.attributes.data.group.data object
              Available includes
              • attributes
              • data.attributes.data.group.data.id string
              • data.attributes.data.group.data.name object
              • data.attributes.data.group.data.handle string
              • data.attributes.data.group.data.position integer(int32)
              • data.attributes.data.group.data.
        • data.attributes.meta object
          • data.attributes.meta.current_page integer(int32)
          • data.attributes.meta.from integer
          • data.attributes.meta.last_page integer
          • data.attributes.meta.path string
          • data.attributes.meta.per_page integer
          • data.attributes.meta.to integer
          • data.attributes.meta.total integer
        • data.attributes.links object
          • data.attributes.links.first string
          • data.attributes.links.last string
          • data.attributes.links.prev string
          • data.attributes.links.next string
      • data.customer_groups object
        • data.customer_groups.data array[object]
          • data.customer_groups.data.id string
          • data.customer_groups.data.name string
          • data.customer_groups.data.handle string
          • data.customer_groups.data.visible string
          • data.customer_groups.data.purchasable boolean
        • data.customer_groups.meta object
          • data.customer_groups.meta.current_page integer(int32)
          • data.customer_groups.meta.from integer
          • data.customer_groups.meta.last_page integer
          • data.customer_groups.meta.path string
          • data.customer_groups.meta.per_page integer
          • data.customer_groups.meta.to integer
          • data.customer_groups.meta.total integer
        • data.customer_groups.links object
          • data.customer_groups.links.first string
          • data.customer_groups.links.last string
          • data.customer_groups.links.prev string
          • data.customer_groups.links.next string
      • data.products object
        • data.products.data array[]
        • data.products.meta object
          • data.products.meta.current_page integer(int32)
          • data.products.meta.from integer
          • data.products.meta.last_page integer
          • data.products.meta.path string
          • data.products.meta.per_page integer
          • data.products.meta.to integer
          • data.products.meta.total integer
        • data.products.links object
          • data.products.links.first string
          • data.products.links.last string
          • data.products.links.prev string
          • data.products.links.next string
  • 404 object

    Not Found

    • error object
      • error.http_code integer
      • error.message string
Definition
POST http://localhost:3000/api/v1/categories/{categoryId}/channels
cURL example
curl \ -X POST http://localhost:3000/api/v1/categories/{categoryId}/channels \ -H "Content-Type: application/json" \ -d '{"channels":[{"id":"id","published_at":"published_at"}]}'
Request payload example
{ "channels": [ { "id": "id", "published_at": "published_at" } ] }
Response example (200)
{ "data": { "primary_asset": { "data": { "extension": "extension", "kind": "kind", "caption": "caption", "title": "title", "type": "type",