openapi: 3.2.0
info:
version: 0.1.1
title: Back Market - API Guidelines Categories API
description: "## Table of contents\n\n1. [Introduction](#introduction)\n1. [Getting started](#getting-started)\n1. [Technical requirements](#technical-requirements)\n1. [F.A.Q. and Contact](#faq-and-contact)\n1. [Cookbooks](#cookbooks)\n\n## Introduction\n\nWelcome to Back Market, the leading online marketplace dedicated to refurbished products.\n\nOur back-office and our web-services have been created in order to allow Seller to manage their products\neasily on our marketplace. This documentation is meant to help you integrate our marketplace and learn how to manage\nyour `Products`, `Offers` and `Orders` on Back Market.\n\n### Overview of what this documentation is talking about\n\n* Our Taxonomy : This part will describe the organization and classification of our marketplace\n* Products & Offers : You will learn how to create `Products` as well as create, update and list `Offers` on Back Market\n* Your Orders : The `Orders` workflow, listing and update will be explained\n\nDifferent solutions are offered in order to use our marketplace. It's possible to work with a combination of\nthese solutions or to switch from one to another at a later stage.\n\n1 - Back Market API:\n\nThis is the best solution for big and/or small sellers with their own technical team. Working with our API will\nenable you to synchronize your information with our database in real time. It is especially suitable for sellers\nwith long-tail catalogs as well as a large amount of sales.\n\n2 - Back-office:\n\nOur <a target=\"_blank\" href=\"https://www.backmarket.fr/bo_merchant/\"> back-office</a> offers a graphic user\ninterface which allows you to manage everything simply and efficiently.\n\nOur back-office also gives you the possibility to import and export CSV files\nwith `Products`, `Offers` and `Orders` information.\nThis allows you to work with more `Offers` comfortably.\n\n3 - DEPRECATED FTP :\n\nFTP in Back Market is deprecated. If you used to use FTP in order to connect to Back Market\nPlease contact <partner-support@backmarket.com> to help you to setup an API connexion.\n\n### Other information\n\nOn this website, we've collected all the information you might need to get on board as smoothly as possible.\nAlso, be sure to check our [F.A.Q.](#f-a-q-and-contact) to get answers to your questions.\n[Contact us](#f-a-q-and-contact) if you still have further questions.\n\n### Feedback\n\nAt Back Market, we always want to improve our solutions.\nPlease [Give Us Feedback](mailto:<partner-support@backmarket.com>?subject=Feedback Back Market Doc) and let us\n know about possible improvement we could make, be it on this documentation, our web services,\n our back-office or whatever you might think of.\nPlease note that this mail is temporary as we will deploy a new Seller support center\nthat will assist you.\n\n## Getting Started\n\nIf you did not yet read the page on [taxonomy](operations/get-bm-catalog-category#taxonomy), please do it before proceeding.\n\n### Account\n\nAfter validation by our team, each Seller gains access to an account. This account gives you access to the Back\nMarket Back Office and our API.\n\nUse one of the following links to access your Back Office account or create one if you haven't done so already.\nYou will need to provide information about your company and we will get back to you as soon as possible:\n\n* <a target=\"_blank\" href=\"https://www.backmarket.co.jp/bo-seller\">AP platform</a>\n* <a target=\"_blank\" href=\"https://www.backmarket.fr/bo-seller\">EU platform</a>\n* <a target=\"_blank\" href=\"https://www.backmarket.com/bo-seller\">US platform</a>\n\nFor creating or accessing an account on the preprod, you can use the following links:\n\n* <a target=\"_blank\" href=\"https://preprod.backmarket.co.jp/bo-seller\">AP preprod platform</a>\n* <a target=\"_blank\" href=\"https://preprod.backmarket.fr/bo-seller\">EU preprod platform</a>\n* <a target=\"_blank\" href=\"https://preprod.backmarket.com/bo-seller\">US preprod platform</a>\n\n### Country code\n\nBack Market is international so you can sell products abroad. The\ncountry code matches both the targeted language and country for the\naction you'd like to perform (ex: update the price for a listing in\nItaly).\nInformation about every countries are contained in the same instance\nof an object `Product` or a `Listing`.\n\nIndeed, you don't need to create one `Listing` for each country. This\n`Listing` will contain some fields which are the same for all the countries (_listing_id, quantity, ..._) and other\n country specific fields (_comment, price and warranty_delay_).\nTherefore, if you wish to edit the _**stock**_ (field :\n'quantity'), the change will apply to all the countries, but for the\n_**comment**_ you will have to change it for each country.\n\nIn the same way, some fields of the `Product` are common for all\ncountries (_weight, EAN, ..._), and others depend on the country\n(_description, title and price_new_).\n\n**COUNTRY_CODES** - Accepted values are :\n\n* AP platform:\n\n * ja-jp : Japan\n * en-au : Australia\n\n* EU platform:\n\n * fr-fr : France\n * fr-be : Belgium\n * es-es : Spain\n * de-de : Germany\n * de-at : Austria\n * it-it : Italy\n * en-gb : United Kingdom\n * nl-nl : Netherlands\n * pt-pt : Portugal\n * en-ie : Ireland\n * el-gr : Greece\n * sk-sk : Slovakia\n * sv-se : Sweden\n\n* US platform:\n\n * en-us : United States\n\n### CSV file format\n\nAll files imported through our Back Office or imported using Back Market's API must be in CSV format.\n\nRequired field separator is ';'.\n\nRequired line separator is the line feed '\\n'.\n\nFields must be surrounded by double quotes.\n## Technical Requirements\n\n### API Identification\n>\n> HTTP Header (will remain the same for every API call):\n\n```http\nContent-type: application/json\nAccept: application/json\nAccept-Language: COUNTRY_CODE\nAuthorization: Basic YOUR_ACCESS_TOKEN\nUser-Agent: YOUR_USER_AGENT\n```\n\nEach Integrator or Seller should use the following HTTP Header when calling Back Market API endpoints.\n\nThe User-Agent is mandatory. Any request without it might be refused by our System.\n\nIt should include your company name, application name, version, and a contact email address in this format:\n\n```http\nBM-{CompanyName}-{IntegrationName};company@companydomain.com.\n```\n\nFor example:\n\n```http\nBM-Ebay-Invoices;contact@ebay.com\nBM-bouygues-automations;contact@bouygues.fr\n```\n\n### Web application firewall (WAF) and Bot management\n\nThe WAF or bot management may block your requests for security reason. You'll typically receive an HTTP 403 Forbidden\nresponse, possibly with a response body to tell you to challenge your client with Cloudflare.\n\nIn case you judge that your request should not be blocked by Cloudflare, from the response headers, you can get the value of cf-ray and send it to your seller contact for investigation.\n\nExample HTTP 403 response from WAF:\n\n```http\nHTTP/2 403\ndate: Wed, 16 Apr 2025 11:26:41 GMT\ncontent-type: text/html; charset=UTF-8\nreferrer-policy: same-origin\ncache-control: max-age=15\nexpires: Wed, 16 Apr 2025 11:26:56 GMT\n...\nx-content-type-options: nosniff\nx-frame-options: SAMEORIGIN\nserver: cloudflare\ncf-ray: 931354450813d142-CDG\nalt-svc: h3=\":443\"; ma=86400\n```\n\nExample HTTP 403 response for Bot Management protected endpoints:\n\n```json\n{\n \"errors\": [\n {\n \"code\": \"bot-need-challenge\",\n \"message\": \"Forbidden\",\n \"challengePath\": \"/testchallengepage\"\n }\n ]\n}\n```\n\n### Traffic limitation\n\nOur standard rate limits are will allow your automations to run fast enough to finish your processes.\nHowever, in case of too many requests beyond what we except on sellers endpoints, you will be presented with an HTTP 429 response from Cloudflare.\n\nUsually you will find the range above 200 requests in 10 seconds being blocked for 10 seconds and for more sensible\nendpoints like catalog for example above 20 requests in 10 seconds being blocked for 10 seconds.\n\n### Data limitation\n\nTo make sure we can handle and process all the incoming data correctly, we have set-up the following limitation:\n**We might not accept more than 2k lines of SKUs to process per hour** on the\n following endpoints ([Update Several listings](#update-several-listings) or\n on [Update specific listing](#update-specific-listing)) and [Update Listings](#update-listings)) files.\nFTP in Back Market is deprecated. If you used to use FTP in order to connect to Back Market\nPlease contact <partner-support@backmarket.com> to help you to setup an API connexion.\n\n**If this limit is reached, Back Market may refuse the task**, in this case you will receive HTTP responses\nwith the \"429 Too Many Requests\" status.\n\nIf you have lots of active SKUs, please take into account the [Best Practice](#best-practices)\npart of the documentation.\n\n### Questions ?\n\nIf you have any questions, please send an email to <partner-support@backmarket.com>\nPlease note that this mail is temporary as we will deploy a new seller support center\nthat will assist you.\n## F.A.Q. and Contact\n\nPlease [click here](https://merchant-support.backmarket.com/hc/en-us) to access your Seller Support Center\n where you can find our F.A.Q. or contact us.\n\nIf you have never signed in to the Seller Support Center, you can\n read this [tutorial](statics/How-to-connect-to-SSC.pdf) which helps you setup you connection for the first time.\n\nIf you have any more questions and are already selling on Back Market, we invite you to contact your account manager.\n## Cookbooks\n\nA list of notebooks showcasing different API use cases:\n\n[Winning the BackBox based on small price efforts](https://colab.research.google.com/drive/12jHZ3AQG8mQjjAvulG9zVvfC_psEOKjh?usp=sharing)\n"
contact:
name: Seller Support Center
url: https://merchant-support.backmarket.com/hc/en-us
x-slack: NA
email: NA@NA.com
servers:
- url: https://preprod.backmarket.co.jp
description: Preprod - AP
- url: https://www.backmarket.co.jp
description: Prod - AP
- url: https://preprod.backmarket.fr
description: Preprod - EU
- url: https://www.backmarket.fr
description: Prod - EU
- url: https://preprod.backmarket.com
description: Preprod - NA
- url: https://www.backmarket.com
description: Prod - NA
tags:
- name: Categories
paths:
/ws/category/tree:
parameters:
- name: Accept-Language
in: header
description: 'Select what market will be used to apply filters and export data.
Passed as the language code related to this market.
'
required: false
example: fr-fr
schema:
$ref: '#/components/schemas/Locale'
get:
summary: Get category tree
description: "\n## Taxonomy\n\n### Categorization & products\n\n`Categories` tree diagram :\n<img class=\"myImg\" src=\"https://s3-eu-west-1.amazonaws.com/backmarket-doc-developer/images_to_download/\ncategory_tree_schema.png\" width=100% height=auto alt=\"\">\n\nDiagram of matching `Product` with a leaf `Category` :\n\n<img class=\"myImg\"\n src=\"https://s3-eu-west-1.amazonaws.com/backmarket-doc-developer/images_to_download/category_product.png\"\n width=100% height=auto alt=\"\">\n<br>\n\nThe matching of a `Product` to a `Category` is made using its `marketplace_category_id`. The `category_id` of\n the model `Product` matches the `marketplace_category_id` of the model `Category` (and not the `category_id`).\n\n On Back Market, many types of `Products` are being sold: smartphones, phones, computers, coffee machines, etc.\n\n Each `Product` created on our marketplace is classified within the 3 levels of `Categories`.\n A `Product` can only be attached to one `Category leaf` (the last level of the Category tree).\n\n `Category 2` and `Category 3` can only have one parent `Category`.\n If it is a `leaf Category`, it cannot have any `child Category`. Otherwise,\n `Category` can have several `children Categories`.\n\n For each `Product` on Back Market several merchants can publish an offer.\n If a `Product` does not exist on our platform, a merchant can create the `Product`.\n The newly created `Product` will then go through a validation process by our\n team (usually within 12 hours of a working day) before being put online.\n\n In addition to some mandatory fields for each `Products` (_cf._ Table 3), the `leaf Category` defines `Attributes`\n (which can be **mandatory** or **optional**) to provide\n during the creation of a `Product`.\n Therefore, when creating a `Product`, some fields will depend on the `leaf Category` of\n the `Product` (category `Attributes`) you create.\n Others will always be the same for every `Products` you create (_cf._ Table 3).\n\n **In summary, if you want to create a `Product`, you will have to provide**:\n\n* The `EAN` (European Article Number) of the `Product`.\n* **Mandatory** product fields (_cf._ Table 3).\n* The `marketplace_category_id` (to match the `Product` with its `leaf Category`).\n* **Mandatory** category `Attributes` (which depend on the `leaf Category`).\n\n Only the merchant who created the `Product` can update it.\n **The update can only be done before our team validates the product.**.\n\n#### Table 1 - `Category` model\n\n<table class=\"table\">\n <thead>\n <tr>\n <th>Field name</th>\n <th>Type/Size</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>category_id</td>\n <td>Int</td>\n <td>Unique ID of the category.</td>\n </tr>\n <tr>\n <td>category_name</td>\n <td>String/200</td>\n <td>Name of the category.</td>\n </tr>\n <tr>\n <td>marketplace_category_id</td>\n <td>Int</td>\n <td>Unique Id of the `Category` to provide on `Product` creation. Allows matching\n of a `Product` to its `leaf Category`.</td>\n </tr>\n <tr>\n <td>is_leaf</td>\n <td>Bool</td>\n <td>If True, the `Category` does not have any child & `Products` can be associated with\n it.</td>\n </tr>\n <tr>\n <td>attributes</td>\n <td>Array[`Attributes`]</td>\n <td>List of `Attributes` attached to a `leaf Category`.</td>\n </tr>\n <tr>\n <td>childrens</td>\n <td>Array[`Category`]</td>\n <td>List of children `Categories`. Empty if is_leaf==True.</td>\n </tr>\n </tbody>\n</table>\n\n#### Table 2 - `Attribute` model\n\n<table class=\"table\">\n <thead>\n <tr>\n <th>Field name</th>\n <th>Type/Size</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>field</td>\n <td>String/200</td>\n <td>Field to provide during creation of a `Product`.</td>\n </tr>\n <tr>\n <td>field_name</td>\n <td>String/200</td>\n <td>Name of the `Attribute`.</td>\n </tr>\n <tr>\n <td>type</td>\n <td>Int</td>\n <td>\n <div>0: \"Decimal\"</div>\n <div>1: \"Integer\"</div>\n <div>2: \"String\"</div>\n <div>3: \"Multiple_Choice\"</div>\n </td>\n </tr>\n <tr>\n <td>allowed_values</td>\n <td>String/1000</td>\n <td>If `type` is \"Multiple_Choice\": accepted values separated by \",\".</td>\n </tr>\n <tr>\n <td>required</td>\n <td>Bool</td>\n <td>True if the attribute is mandatory to create the Product.</td>\n </tr>\n </tbody>\n</table>\n\n#### Table 3 - `Product` model\n\n Fields to provide are the same for every `Product` and don't depend on its `Category`.\n A **unique product ID** is provided at the creation of a `Product`.\n\n<table class=\"table\">\n <thead>\n <tr>\n <th>Field name</th>\n <th>Type/Size</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>product_id</td>\n <td>String</td>\n <td>Unique product Id. Provided by Back Market at the creation of a `Product` for purpose of matching to `Listings`.</td>\n </tr>\n</tbody>\n</table>\n\n**Required fields:**\n<table class=\"table\">\n <thead>\n <tr>\n <th>Field name</th>\n <th>Type/Size</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>ean</td>\n <td>String/13</td>\n <td>`EAN` used to match an already existing `Product`. A new `Product` is created\n if there is no match. Also used to match a Listing at its creation if the Back Markert ID is not provided.</td>\n </tr>\n <tr>\n <td>category_id</td>\n <td>Int</td>\n <td>Matches the marketplace_category_id. Unique ID of a selected `Category`,\n to be provided during creation of a `Product`. Allows matching a `Product` to its `leaf Category`.</td>\n </tr>\n <tr>\n <td>title</td>\n <td>String/200</td>\n <td>Product title.</td>\n </tr>\n <tr>\n <td>description</td>\n <td>Text</td>\n <td>Product description.</td>\n </tr>\n <tr>\n <td>brand</td>\n <td>String/100</td>\n <td>Product brand.</td>\n </tr>\n <tr>\n <td>price_new</td>\n <td>Decimal</td>\n <td>Market price of the product sold new.</td>\n </tr>\n <tr>\n <td>weight</td>\n <td>Int > 1</td>\n <td>Weight in grams (g).</td>\n </tr>\n <tr>\n <td>image1</td>\n <td>String/1000</td>\n <td>First image.</td>\n </tr>\n </tbody>\n</table>\n\n**Optional fields:**\n<table class=\"table\">\n <thead>\n <tr>\n <th>Field name</th>\n <th>Type/Size</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>image2</td>\n <td>String/1000</td>\n <td>Second image.</td>\n </tr>\n <tr>\n <td>image3</td>\n <td>String/1000</td>\n <td>Third image.</td>\n </tr>\n <tr>\n <td>image4</td>\n <td>String/1000</td>\n <td>Fourth image.</td>\n </tr>\n <tr>\n <td>image5</td>\n <td>String/1000</td>\n <td>Fifth image.</td>\n </tr>\n <tr>\n <td>image6</td>\n <td>String/1000</td>\n <td>Sixth image.</td>\n </tr>\n <tr>\n <td>width</td>\n <td>String/200</td>\n <td>Width.</td>\n </tr>\n <tr>\n <td>height</td>\n <td>String/200</td>\n <td>Height.</td>\n </tr>\n <tr>\n <td>depth</td>\n <td>String/200</td>\n <td>Depth.</td>\n </tr>\n </tbody>\n</table>\n\n<aside class=\"notice\">\nTo create a `Product` you need to at least provide mandatory product fields and mandatory category `Attributes` of the `leaf\nCategory`.\n</aside>\n\n#### Fields depending on the country_code\n\nFor each `Product`, some fields depend on the country and some are in common for every country.\n\nHere is the list of fields for the Product model that vary by country (and need to be specified for each country):\n\n* 'title'\n* 'description'\n* 'price_new'\n\n## Get category tree\n\nIf you want to sell a new `Product`, which has not already been added on our marketplace by another merchant, you will need to create it.\n\nIn this case, you need to select one `leaf Category` and check the corresponding `Attributes`.\nThis will let you know all mandatory or optional `Attributes` you need to provide during the creation of the `Product`.\n\nThis section allows to retrieve Back Market's `Category tree`, including all its branches.\n\n### Endpoint\n\n<aside class=\"success\">\n HTTP GET request: <a target=\"_blank\" href=\"https://www.backmarket.fr/ws/category/tree/\"> https://www.backmarket.fr/ws/category/tree/</a>\n</aside>\n\n### HTTP request\n\nNo request Body.\n\n```javascript\n# Example of JSON response - Status code 200\n\n[\n {\n \"category_id\":1,\n \"category_name\":\"T\\u00e9l\\u00e9phones\",\n \"marketplace_category_id\":-1,\n \"is_leaf\":false,\n \"attributes\":[],\n \"childrens\":[\n {\n \"category_id\":2,\n \"category_name\":\"Old School\",\n \"marketplace_category_id\":-10001,\n \"is_leaf\":false,\n \"attributes\":[],\n \"childrens\":[\n {\n \"category_id\":3,\n \"category_name\":\"Old School\",\n \"marketplace_category_id\":1,\n \"is_leaf\":true,\n \"attributes\":[\n {\n \"field\":\"color\",\n \"field_name\":\"Couleur\",\n \"type\": 2,\n \"allowed_values\":\"\",\n \"required\":true\n },\n {\n \"field\":\"screen_size\",\n \"field_name\":\"Taille \\u00e9cran (pouces)\",\n \"type\": 2,\n \"allowed_values\":\"\",\n \"required\":true\n },\n {...}\n ],\n \"childrens\":[]\n }\n ]\n },\n {...}\n ]\n },\n {...}\n]\n\n```\n\n### Response parameters\n\n_**`Category` fields :**_\n\n<table class=\"table\">\n <thead>\n <tr>\n <th>Field name</th>\n <th>Type/Size</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>category_id</td>\n <td>Int</td>\n <td>Unique ID of the `Category`.</td>\n </tr>\n <tr>\n <td>category_name</td>\n <td>String/200</td>\n <td>Name of the `Category`.</td>\n </tr>\n <tr>\n <td>marketplace_category_id</td>\n <td>Int</td>\n <td>Unique Id of the `Category` to provide during the creation of a `Product`. Allows matching\n a `Product` & its `leaf Category`.</td>\n </tr>\n <tr>\n <td>is_leaf</td>\n <td>Bool</td>\n <td>If True, the `Category` does not have any children & `Products` can assigned to it.</td>\n </tr>\n <tr>\n <td>attributes</td>\n <td>Array[Attributes]</td>\n <td>List of `Attributes` attached to a `leaf Category`.</td>\n </tr>\n <tr>\n <td>childrens</td>\n <td>Array[Category]</td>\n <td>List of children `Categories`. Empty if is_leaf==True.</td>\n </tr>\n </tbody>\n</table>\n\n_**`Attribute` fields :**_\n\n<table class=\"table\">\n <thead>\n <tr>\n <th>Field name</th>\n <th>Type/Size</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>field</td>\n <td>String/200</td>\n <td>Field to provide at `Products` creation.</td>\n </tr>\n <tr>\n <td>field_name</td>\n <td>String/200</td>\n <td>Name of the `Attribute`.</td>\n </tr>\n <tr>\n <td>type</td>\n <td>Int</td>\n <td>\n <div>0: \"Decimal\"</div>\n <div>1: \"Integer\"</div>\n <div>2: \"String\"</div>\n <div>3: \"Multiple_Choice\"</div>\n </td>\n </tr>\n <tr>\n <td>allowed_values</td>\n <td>String/1000</td>\n <td>If `type` is \"Multiple_Choice\": accepted values separated by \",\".</td>\n </tr>\n <tr>\n <td>required</td>\n <td>Bool</td>\n <td>True if the `Attribute` is mandatory to create the `Product`.</td>\n </tr>\n </tbody>\n</table>\n\n### Response status codes\n\n<table class=\"table\">\n <thead>\n <tr>\n <th>Status code</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr class=\"success\">\n <td>200</td>\n <td>\n OK.\n </td>\n </tr>\n <tr class=\"danger\">\n <td>400</td>\n <td>\n Bad request.\n </td>\n </tr>\n <tr class=\"danger\">\n <td>403</td>\n <td>\n Forbidden.\n </td>\n </tr>\n <tr class=\"danger\">\n <td>404</td>\n <td>\n Webservices unavailable.\n </td>\n </tr>\n </tbody>\n</table>\n\n## Create/Update category\n\n`Category` cannot be created nor updated by merchants.\n\nYou might want to create a `Category` if you wish to sell a new kind of `Product`, which cannot be referenced in already existing Categories.\n\nYou might also want to update a `Category` in the event that you wish to create a `Product` that already exists in the relevant `Category` but for which you can't provide all the mandatory `Attributes`. In this case, you would want the **mandatory** field to become **optional**.\n\nIf you wish to create or update a `Category`, please <a target=\"_blank\" href=\"https://merchant-support.backmarket.com/hc/en-us\">let us know</a>.\n"
x-tier: 3
tags:
- Categories
operationId: get-bm-catalog-category
security:
- ApiKeyAuth: []
- BasicAuth: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CategoryTree'
'401':
description: Unauthenticated.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseV2'
'403':
description: Forbidden. Authenticated user is not a merchant.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseV2'
/ws/category/tree/{categoryId}:
parameters:
- in: path
name: categoryId
required: true
example: 1
schema:
type: integer
- name: Accept-Language
in: header
description: 'Select what market will be used to apply filters and export data.
Passed as the language code related to this market.
'
required: false
example: fr-fr
schema:
$ref: '#/components/schemas/Locale'
get:
summary: Get category branch
description: '
Retrieve a specific `Category` branch. This will only give you access to what''s below on the branch. This means that you won''t be able to access the parent `Categories`, but only children `Categories` and `Attributes`.
You can retrieve `Attributes` from a specific `leaf Category` with the following endpoint, by providing its category ID.
'
x-tier: 3
tags:
- Categories
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CategoryTree'
'401':
description: Unauthenticated.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseV1'
'403':
description: Forbidden. Authenticated user is not a merchant.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseV1'
'404':
description: Category not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseV1'
components:
schemas:
Error:
description: ''
properties:
code:
type: string
data:
type: object
docLink:
type: string
message:
type: string
target:
type: string
required:
- code
- message
type: object
ErrorResponseV2:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
minItems: 1
requestId:
type: string
description: Let you trace errors in applicative logs
required:
- errors
ErrorResponseV1:
type: object
properties:
error:
$ref: '#/components/schemas/Error'
requestId:
description: Let you trace errors in applicative logs
type: string
required:
- error
Locale:
pattern: ^[a-z]{2}-[a-z]{2}$
type: string
CategoryTree:
type: object
properties:
category_id:
type: integer
example: 1
category_name:
type: string
example: Smartphone
marketplace_category_id:
type: integer
example: 123
is_leaf:
type: boolean
example: false
attributes:
type: array
items:
type: object
properties:
field:
type: string
example: color
field_name:
type: string
example: Couleur
type:
type: integer
description: '- 0: DECIMAL, 1:INTEGER, 2:STRING, 3:MULTIPLE_CHOICE
'
example: 2
enum:
- 0
- 1
- 2
- 3
allowed_values:
type: string
description: List of allowed values for the given product attribute, separated by commas.
example: Unlocked GSM, Unlocked CMDA,AT&T,Verizon,Sprint,T Mobile,Boost Mobile,No SIM slot
required:
type: boolean
example: true
required:
- field
- field_name
- type
- allowed_values
- required
required:
- category_id
- category_name
- marketplace_category_id
- is_leaf
- childrens
- attributes
securitySchemes:
ApiKeyAuth:
in: header
name: Authorization
type: apiKey
description: 'Token authentication is done with Basic authentication.
Prefix the value with \"Basic\" and use the token you created in the backoffice in the Integrations option page.'
BasicAuth:
type: http
scheme: basic