Pixel management

Considerations

• The application must be registered at https://developers.mercadolibre.com, obtaining the application_id. (The application must be registered in Mshop).
• To authorize requests, Oauth is used (more info).
• Keep in mind that an application_id can only have one pixel_id. To acquire another, you must register another application. In turn, a Pixel_id can have multiple sellers associated with it.
• To associate a script with a seller, the latter must have delegated a domain to MercadoShops. If this step was not performed, the API will return a status code 401 with the following message: Your shop is not authorized for this request, you must have a delegated domain. To identify if the seller has a delegated domain or not (more info.)
• The format of the scripts must be a Handlebars template such that a JavaScript code can be obtained by replacing the user variable. The JavaScript code obtained from the script must be able to be executed within a condition. Additionally, it is preferable that the script be kept as small as possible, with a total size less than 2kB, and if additional logic is needed, the script should make a call to fetch and execute another JavaScript file stored on a CDN provided by the Integrator.
• The name of the .Json file cannot have spaces or special characters, Custom-script does not allow them in the names of the Pixels.
• The script must contain the variable that is defined in the .Json file. It is feasible to call the variable VARIABLE.

Example of correct scripts:

script.hbs

if (/*condition*/) { 
var 
src="https://test-pixel.com/api/script/mercadoshops/onLoad.js?=shop123"; var script = document.createElement("script"); 
script.setAttribute("src", src); 
document.getElementsByTagName("head")[0].appendChild(script); 
} 

This scripts will be displayed in the store as follows:

var src="https://test-pixel.com/api/script/mercadoshops/onLoad.js?={{VARIABLE}}"; var script = document.createElement("script"); 
script.setAttribute("src", src); 
document.getElementsByTagName("head")[0].appendChild(script); 

Example of incorrect scripts:

Glossary of fields and parameters

Identify the Store Domain

Request:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN'
https://api.mercadolibre.com/shops/public-domains

Response:

{
    "domain": "www.shop.domain.com",
    "shop_id": 123242154125,
    "status": "ACTIVE",
    "delegation_type": "PARTIAL",
    "site": "MCO"
}

Response Parameters

Errors

Associate script to seller's shop

Request:

curl -X POST-H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -d
    {...}
https://api.mercadolibre.com/shops/custom-scripts/ext/integration

Example:

curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -d
'{
  "pixel_id": "XXXXX",
  "sections": ["home", "search", "vip", "cart", "contact"],
  "external_client_id": "XXXXX",
}
'
https://api.mercadolibre.com/shops/custom-scripts/ext/integration

Response:

{
  "id": "XXXXX",
  "pixel": {
    "id": "XXXXX",
    "description": "XXXXX"
  },
  "created_at": "XXXXX",
  "sections": ["home", "search", "vip", "cart", "contact"]
}

Disable pixel

Con el el siguiente recurso podrás desactivar el pixel en todas las secciones en que se activó previamente al usuario (vendedor).

Request:

curl -X DELETE -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/shops/custom-scripts/ext/integration?integration_id={INTEGRATION_ID}

Example:

curl -X DELETE -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/shops/custom-scripts/ext/integration?integration_id={INTEGRATION_ID}

Response:

{
  "updated_at": "XX/XX/XX",
  "status": "Disabled",
  "external_client_id": "XXXXX"
}

Status Code