openapi: 3.2.0
info:
version: 0.1.1
title: Back Market - API Guidelines Backbox 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: Backbox
paths:
/ws/listings_bi:
get:
description: '
Get the Backbox data related to your competitors, i.e. your online listings competing in a Backbox. You can call this endpoint twice every hour for each country.
Backbox (previously named Buybox) is the listing displayed at a given time on the website when it has the best ratio quality score per price.
This endpoint is being deprecated in favor of the /ws/backbox/v1/competitors endpoint.
'
operationId: GetBackboxData
parameters:
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PageSize'
responses:
'200':
content:
application/json:
schema:
properties:
count:
description: Total number of backbox data per listing
example: 42
type: integer
next:
description: URL to get the next paginated backbox data per listing list. Null if no next page
example: https://www.backmarket.fr/ws/listings_bi/?page=2
type:
- string
- 'null'
previous:
description: URL to get the previous paginated backbox data per listing list. Null if no previous page
example: https://www.backmarket.fr/ws/listings_bi/?page=1
type:
- string
- 'null'
results:
description: List of backbox data per listing
items:
$ref: '#/components/schemas/Backbox'
type: array
required:
- count
- next
- previous
- results
type: object
description: List of backbox data per listing
'403':
description: Permission denied
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorResponseV3'
'404':
description: Webservices unavailable
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorResponseV3'
'429':
description: Too many calls
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorResponseV3'
summary: Return backbox data per listing list
tags:
- Backbox
x-category: domain
x-tier: 2
/ws/backbox/v1/competitors/{listingId}:
get:
description: 'Get the Backbox data related to your competitors, i.e. your online listings competing in a Backbox.
You can call this endpoint twice per second per API token.
[Here is an example](https://colab.research.google.com/drive/12jHZ3AQG8mQjjAvulG9zVvfC_psEOKjh?usp=sharing) of how you can use the Listings and the BackBox APIs together, in order to adjust your listings'' prices in case there are some good opportunities. This can allow you to win more BackBoxes automatically with small prices reductions.
'
parameters:
- in: path
name: listingId
required: true
schema:
format: uuid
title: Listing Id
type: string
example: 7e1f4a8d-b1bb-47aa-9f77-2cca759eb41b
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Competitor'
type: array
description: Each item is a competitor, ie. a `listing x market`, competing for a single Backbox.
description: Successful Response
'401':
description: Unauthorized
'404':
description: Not Found
'422':
description: Unprocessable Entity
security:
- ApiKeyAuth: []
- BasicAuth: []
summary: Get competitors
tags:
- Backbox
x-category: domain
x-tier: 2
components:
parameters:
Page:
description: The page number for pagination
example: 2
in: query
name: page
required: false
schema:
default: 1
type: integer
PageSize:
description: The page size for pagination
example: 20
in: query
name: page-size
required: false
schema:
default: 10
type: integer
maximum: 50
schemas:
ErrorResponseV3:
type: object
properties:
error:
$ref: '#/components/schemas/Error'
status:
description: HTTP status code
type: integer
title:
description: summary of the problem type
type:
- string
- 'null'
type:
description: unique problem identifier
type:
- string
- 'null'
requestId:
description: ID of the request
type: string
required:
- error
- status
- title
- type
Error:
description: ''
properties:
code:
type: string
data:
type: object
docLink:
type: string
message:
type: string
target:
type: string
required:
- code
- message
type: object
MarketCode:
type: string
description: Two-letter country code of the market. Format ISO_3166-2
enum:
- FR
- BE
- DE
- IT
- ES
- GB
- AT
- NL
- US
- FI
- PT
- IE
- GR
- SK
- SE
- JP
example: FR
ProductCondition:
type: integer
enum:
- 9
- 10
- 11
- 12
description: 'Condition of the product.
| Value | Description |
|-------|---------------------|
| 9 | Premium condition |
| 1O | Excellent condition |
| 11 | Good condition |
| 12 | Fair condition |
'
example: 10
Competitor:
properties:
is_winning:
description: Whether or not this competitor is winning the backbox.
title: Is Winning
type: boolean
listing_id:
description: The listing public id of this competitor.
format: uuid
title: Listing Id
type: string
min_price:
anyOf:
- $ref: '#/components/schemas/MonetaryAmount'
description: The mimimum price set by the competitor.
price:
allOf:
- $ref: '#/components/schemas/MonetaryAmount'
description: The target price set by the competitor.
price_to_win:
allOf:
- $ref: '#/components/schemas/MonetaryAmount'
description: The price that the competitor must set to win the backbox.
product_id:
description: The product public id of this competitor.
format: uuid
title: Product Id
type: string
winner_price:
anyOf:
- $ref: '#/components/schemas/MonetaryAmount'
description: The price of the backbox i.e. the selling price of the winner.
market:
anyOf:
- $ref: '#/components/schemas/MarketCode'
description: The market of the backbox.
required:
- listing_id
- product_id
- price
- min_price
- price_to_win
- winner_price
- is_winning
- market
title: Competitor
type: object
MonetaryAmount:
title: MonetaryAmount
type: object
example:
amount: '42'
currency: EUR
properties:
amount:
type: string
pattern: ^\d*(\.\d*)?$
description: 'Amount is a human representation of a decimal, without any localization.
Trailing zero in decimal places MAY be passed (eg: "13.0")
Values with more decimal places than the minor unit of the currency MUST NOT be considered as valid.
The trailing zero guideline has priority over it.
```
{"amount": "13.000", "currency": "EUR"} is also valid, but {"amount": "13.123", "currency": "EUR"} is not.
```
Leading zero SHOULD be in the amount if the value is between 0 and 1.
Decimal separator MAY be supplied without decimal places.'
example: '42'
currency:
type: string
pattern: ^[A-Z]{3}$
description: 'The currency MUST be represented as a code following the ISO 4217 standard:
"EUR" for euro, "USD" for U.S. dollar, etc.
'
example: EUR
required:
- amount
- currency
description: 'Back Market common monetary amount model.
Empty monetary amount (ie amount equals 0) property SHOULD be exposed according to the following rules:
- `{ amount: ''0.00'', currency: ''EUR|USD|...'' }`
When a monetary amount is 0, and is intended to be displayed. Ex: free warranty, etc.
- `null` when a monetary amount is 0, and is intended to be hidden.
Ex: discount: `null`, when a user has no discount.
- omitted, when a monetary amount is non-existent.
Ex, when a feature is disabled: backlabel: `null` means BackLabel feature is enabled but not on one particular item,
while not having backlabel field at all means BackLabel feature is disabled.'
x-internal: false
Backbox:
title: Backbox
type: object
required:
- product
- sku
- price
- quantity
- buybox
- price_for_buybox
- current
- condition
- same_merchant_winner
properties:
product:
type: integer
description: Product ID
example: 42
sku:
type: string
description: 'SKU used to match to an existing listing (also a listing''s unique Id)
'
example: SuperSKU
price:
type: number
description: Listing price
example: 70
quantity:
type: integer
description: Stock available
example: 10
buybox:
type: boolean
description: Does this listing have Backbox
example: false
price_for_buybox:
type: number
description: If your listing does not have Backbox, the price you will have to set to have it (aka red price)
example: 60
currency:
type: string
description: Currency of the listing, it will depend on the market ("GBP" for UK for instance)
example: EUR
condition:
$ref: '#/components/schemas/ProductCondition'
same_merchant_winner:
type: boolean
description: Does one of your listing have Backbox
example: false
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