Documentação do Mercado Livre
Confira todas as informações necessárias sobre as APIs Mercado Livre.Documentação do
Campanha com co-participação
Consultar detalhes da campanha
Para obter os detalhes de uma oferta com co-participação, realize a seguinte consulta
Chamada:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' 'https://api.mercadolibre.com/seller-promotions/promotions/P-MLB1806015?promotion_type=MARKETPLACE_CAMPAIGN&app_version=v2'
Resposta:
{
"id": "P-MLB1806015",
"type": "MARKETPLACE_CAMPAIGN",
"status": "started",
"start_date": "2023-04-20T02:00:00Z",
"finish_date": "2023-08-01T02:00:00Z",
"deadline_date": "2023-08-01T01:00:00Z",
"name": "Campanha de teste v2",
"benefits": {
"type": "REBATE",
"meli_percent": 5,
"seller_percent": 25
}
}
Campos específicos desta campanha
Benefits: detalhe dos benefícios da promoção.
- type: tipo de benefício.
- meli_percent: porcentagem de contribução do Mercado Livre.
Estado
Estes são os diferentes estados pelos quais uma campanha cofinanciada pode passar.
Estado | Descrição |
---|---|
pending | Promoção aprovada, mas ainda não começou. |
started | Promoção ativa. |
finished | Promoção finalizada. |
Consultar itens em uma campanha
Para conhecer os itens candidatos e/ou que fazem parte de uma campanha de co-participação, faça a seguinte consulta:
Chamada:
curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' 'https://api.mercadolibre.com/seller-promotions/promotions/P-MLB1806015/items?promotion_type=MARKETPLACE_CAMPAIGN&app_version=v2
Resposta:
{
"results": [
{
"id": "MLB3293401659",
"status": "started",
"price": 700,
"original_price": 1000,
"offer_id": "OFFER-MLB3293401659-177366",
"meli_percentage": 5,
"seller_percentage": 25,
"start_date": "2023-04-23T23:06:53Z",
"end_date": "2023-08-01T02:00:00Z"
}
],
"paging": {
"offset": 0,
"limit": 50,
"total": 1
}
}
Ao criar uma nova campanha, todos os itens aplicáveis a ela são selecionados. O estado inicial (status) dos itens é candidato e sem um ID de oferta atribuído. Assim que o vendedor incorpora um item à campanha, seu status é modificado e é atribuído um offer_id único.
Estado do item
Na tabela a seguir você encontra os possíveis estados que os itens podem assumir neste tipo de campanha.
Estado | Descrição |
---|---|
candidate | Item candidato a participar da promoção. |
pending | Item com promoção aprovada e programada. |
started | Item ativo na campanha. |
finished | Item eliminado da campanha |
Indicar itens para uma campanha
Após ter sido convidado a participar de uma campanha de co-participação, indique quais produtos deseja incluir nela.
Chamada:
curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' \
-d '{
"promotion_id":"$PROMOTION_ID",
"promotion_type":"$PROMOTION_TYPE"
}'
https://api.mercadolibre.com/seller-promotions/items/$ITEM_ID?app_version=v2
Exemplo:
curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' \
-d '{
"promotion_id":"P-MLB1806015",
"promotion_type":"MARKETPLACE_CAMPAIGN"
}'
https://api.mercadolibre.com/seller-promotions/items/MLB3293401659?app_version=v2
Resposta:
{
"offer_id": "OFFER-MLB3293401659-177366",
"price": 700,
"original_price": 1000
}
Parâmetros
promotion_id: identificação da promoção.
promotion_type: tipo de promoção (MARKETPLACE_CAMPAIGN).
Modificar itens
Para modificar o preço de um item que participa de uma campanha de co-participação, devem ser realizados os seguintes passos, uma vez que não é possível modificar o preço diretamente.
- Eliminar o item da campanha;
- Modificar o preço do item como sincronização normal de preço;
- Incluir o item novamente na campanha.
Excluir itens
Com este recurso é possível eliminar uma oferta do item.
Chamada:
curl -X DELETE -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/seller-promotions/items/$ITEM_ID?promotion_type=$PROMOTION_TYPE&promotion_id=$PROMOTION_ID&offer_id=$OFFER_ID
Exemplo:
curl -X DELETE -H 'Authorization: Bearer $ACCESS_TOKEN' 'https://api.mercadolibre.com/seller-promotions/items/MLB1834747833?promotion_type=MARKETPLACE_CAMPAIGN&promotion_id=P-MLB379009&offer_id=MLB1834747833-9eafadd4-16d2-49ae-b272-9a7a34585cb8&app_version=v2'
Resposta: Status 200 OK
Conheça mais sobre Descontos por quantidade.
Próxima: Campanhas de desconto por volume