API / Attribute Groups

Update Attribute Group Endpoint

Structure Name Type Description Required name string The name of the attribute group (e.g., Size or Colour) No display_as string The display as of the attribute group (e.g.: dropdown, color_swatches, image_swatches, swatches) No reference string The reference ...

API / Attribute Groups

Delete Attribute Group Endpoint

Example Request DELETE /api/attribute-groups/{id|name} Example Response 204 No Content

API / Attributes

Create Attribute Endpoint

Structure Attribute Name Type Description Required id int The id for the attribute No name string The name of the attribute (e.g., Small or Red) Yes display_name string The display name of the attribute No reference string The reference of the attribute No ima...

API / Attributes

Update Attribute Endpoint

Structure Attribute Name Type Description Required name string The name of the attribute (e.g., Small or Red) No display_name string The display name of the attribute No reference string The reference of the attribute No image object The Image of the attribute...

API / Attributes

Delete Attribute Endpoint

Example Request DELETE /api/attribute-groups/{id|name}/attributes/{id|name} Example Response 204 No Content

API / Categories

View Category Endpoint

Structure Category Name Type Description name string The name of the category parent string The parent of the category slug string The slug of the category, if not present it is auto-generated from name reference string The reference of the category logic stri...

API / Categories

Create Category Endpoint

Structure Category Name Type Description Required id int The id for the category No name string The name of the category Yes parent string The parent of the category No slug string The slug of the category, if not present it is auto-generated from name No refe...

API / Categories

Update Category Endpoint

Structure Category Name Type Description Required name string The name of the category No parent string The parent of the category No slug string The slug of the category, if not present it is auto-generated from name No reference string The reference of the c...

API / Categories

Delete Category Endpoint

Example Request DELETE /api/categories/{id|name|breadcrumb} Example Response 204 No Content

API / Collections

View Collection Endpoint

Structure Collection Name Type Description name string The name of the collection slug string The slug of the collection reference string The reference of the collection logic string The logic of the rules for the collection rules array The listing page rules ...

API / Collections

Create Collection Endpoint

Structure Collection Name Type Description Required id int The id for the collection No name string The name of the collection Yes slug string The slug of the collection, if not present it is auto-generated from name No reference string The reference of the co...

API / Collections

Update Collection Endpoint

Structure Collection Name Type Description Required name string The name of the collection No slug string The slug of the collection, if not present it is auto-generated from name No reference string The reference of the collection No logic string The logic of...

API / Collections

Delete Collection Endpoint

Example Request DELETE /api/collections/{id|name} Example Response 204 No Content

API / Tag Groups

Tag Group Index Endpoint

Structure See View Tag Group Endpoint for the structure of the tag group payload inside the data array. Example Request GET /api/tag-groups?per_page=2 Example Response { "current_page": 1, "data": [ //... ], "first_page_url": "http://ae...

API / Tag Groups

View Tag Group Endpoint

Structure Tag Group Name Type Description name string The name of the tag group (e.g., Size or Colour) reference string The reference of the tag group show_in_filters boolean Whether the tag group shows in filters on listings page tags array An array of Tag ob...

API / Tag Groups

Create Tag Group Endpoint

Structure Tag Group Name Type Description Required id int The id for the tag group No name string The name of the tag group (e.g., Size or Colour) Yes reference string The reference of the tag group No show_in_filters boolean Whether the tag group shows in fil...

API / Tag Groups

Update Tag Group Endpoint

Structure Name Type Description Required name string The name of the tag group (e.g., Size or Colour) No reference string The reference of the tag group No show_in_filters boolean Whether the tag group shows in filters on listings page No Example Request PUT /...

API / Tag Groups

Delete Tag Group Endpoint

Example Request DELETE /api/tag-groups/{id|name} Example Response 204 No Content