BestBuy Authentication & Database structure & Limits
Summary of Changes: (The purpose of this table is to keep traceability and Product team to highlight the things that were changed into the scope, based on comments or discussions)
| Version | Date | Created / Updated | Notes |
|---|---|---|---|
| v1.0 | 29.05.2025 | Bogomil | First publish |
The purpose of this document is to describe how we authenticate on MIRAKL marketplaces and also, to describe the database structure.
Authentication:
The Authentication for MIRAKL accounts consist of environment URL endpoint and API key which are stored in the marketplace account specific table.
Note: As each API Key is specific to an environment, you will need to generate an API key for the test environment and then, one for the production environment
In order to obtain the API key we should follow the steps:
- Log into your Mirakl shop; ( Please contact Bogomil Pavlov or Hristiyan Georgiev )
- Click on your username, in the top right, to access your user settings;
- In the tab “API key”, select “Generate” to create your API key
End point: https://marketplace.bestbuy.ca/
Limits
Mirakl APIs are protected by rate limits. Each API has a dedicated section displaying its rate limit.
If you make too many calls, you might receive an HTTP 429 "Too Many Requests" error. The response will contain a Retry-After header that specifies the number of seconds to wait before making a new request.
GET OR11 - List orders
CALL FREQUENCIES
Recommended:
- Asynchronous: every 5 minutes
- Synchronous: at each order page display
Maximum:
- Asynchronous: once per minute
- Synchronous: at each order page display
PUT OR23 - Update carrier tracking information for a specific order CALL FREQUENCIES
Recommended: At each order tracking information update (as soon as the seller gets the tracking number from the carrier) Maximum: At each order tracking information update (as soon as the seller gets the tracking number from the carrier)
PUT OR24 - Validate the shipment of an order CALL FREQUENCIES
Recommended: Each time the tracking number is entered (OR23) Maximum: Each time the tracking number is entered (OR23)
PUT OR28 - Request refunds on order lines CALL FREQUENCIES
Recommended: At each refund request Maximum: At each refund request
PUT OR30 - Request cancelations on order lines CALL FREQUENCIES
Recommended: At each order (or order line) cancelation Maximum: At each order (or order line) cancelation
GET H11 - List Catalog categories (parents and children) related to a Catalog category CALL FREQUENCIES
Recommended: Every hour Maximum: Every hour
GET PM11 - Get the product attribute configuration CALL FREQUENCIES
Recommended: Every hour Maximum: Every hour
GET VL11 - Get information about operator's value lists CALL FREQUENCIES
Recommended: Every hour Maximum: Every hour
POST P41 - Import products to the operator information system CALL FREQUENCIES
Recommended: Every hour, for each seller Maximum: Every 15 minutes, for each seller
GET P42 - Get the import status for a product import CALL FREQUENCIES
Recommended: Once per minute until getting the import final status Maximum: Once per minute
GET P44 - Get the error report file for a product import CALL FREQUENCIES
Recommended: Each time an error report is needed Maximum: Each time an error report is needed
GET P47 - Get the transformation error report file for a product import CALL FREQUENCIES
Recommended: Each time an error report is needed Maximum: Each time an error report is needed
POST OF01 - Import a file to add offers CALL FREQUENCIES
Recommended: Every 5 minutes Maximum: Once per minute
GET OF02 - Get information and statistics about an offer import CALL FREQUENCIES
Recommended: After each OF01 call, every 5 minutes Maximum: Once per minute
GET OF03 - Get the error report file for an offer import CALL FREQUENCIES
Recommended: After each OF02 call, every 5 minutes Maximum: Once per minute