Documentation Mercado Libre

Check out all the necessary information about APIs Mercado Libre.
circulos azuis em degrade

Documentation

Last update 26/02/2024

Co-funded campaigns (MARKETPLACE CAMPAIGN)

Sellers are regularly invited to participate in different website campaigns.
The main characteristic of this type of campaign is that Mercado Libre pays a percentage of the offered discount.
If you received an invitation and want to join, use the resources below.



Check campaign details

To check promotion details, please perform the following action:

Request:

curl -H 'Authorization: Bearer $ACCESS_TOKEN' -X GET https://api.mercadolibre.com/marketplace/seller-promotions/promotions/$PROMOTION_ID?promotion_type=MARKETPLACE_CAMPAIGN&user_id=$USER_ID

Example:

curl -H 'Authorization: Bearer $ACCESS_TOKEN' -X GET https://api.mercadolibre.com/marketplace/seller-promotions/promotions/P-MLM1806015?promotion_type=MARKETPLACE_CAMPAIGN&user_id=1317418851'
  --header 'version: v2' \
  --header 'X-Client-Id: 1317417907' \
  --header 'X-Caller-Id: 1317417907' \
  

Reponse:

{
    "id": "P-MLM1806015",
    "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": "Test Campaign v2",
    "benefits": {
        "type": "REBATE",
        "meli_percent": 5,
        "seller_percent": 25
    }
  }

Specific campaign fields

Benefits: promotion benefit details.

  • type: type of benefit.
  • meli_percent: percentage contributed by Mercado Libre.
  • seller_percent: percentage contributed by seller.

  • Status

    Find below the different co-funded campaign statuses:

    Status Description
    pending_approval promotion approved.
    pending promotion approved but not yet started.
    started active promotion.
    finished finished promotion.

    Check campaign Items

    Perform the query below to see candidate items and/or the items included in a co-funded campaign:

    Request:

    curl -H 'Authorization: Bearer $ACCESS_TOKEN' -X GET https://api.mercadolibre.com/marketplace/seller-promotions/promotions/$PROMOTION_ID?/items?user_id=$USER_ID
      --header 'version: v2' \
      --header 'X-Client-Id: \
      --header 'X-Caller-Id: \
      

    Example:

    curl -H 'Authorization: Bearer $ACCESS_TOKEN' -X GET https://api.mercadolibre.com/marketplace/seller-promotions/promotions/P-MLM1806015/items?user_id=1317418851' \
      --header 'version: v2' \
      --header 'X-Client-Id: 1317417907' \
      --header 'X-Caller-Id: 1317417907' \

    Response:

    {
      "results": [
          {
              "id": "MLM3293401659",
              "status": "started",
              "price": 700,
              "original_price": 1000,
              "offer_id": "OFFER-MLM3293401659-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
      }
    }

    When a new campaign is created, all applicable items are selected. The initial item (status) is "candidate" with no assigned offer ID. When the seller adds an item to the campaign, item status changes and a unique offer_id is assigned.


    Item status

    Status Description
    candidate candidate item to participate in the promotion.
    pending approved and programmed promotion item.
    started campaign active item.
    finished Item deleted from campaign

    Submit an item to a campaign

    Note:
    See that to indicate and remove this campaign from an item we use promotion_id instead of deal_id.

    Once you are invited to participate in a co-funded campaign, you can specify the products to be included.

    Request:

    curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' \ -d '{
      "promotion_id":"$PROMOTION_ID",
      "promotion_type":"$PROMOTION_TYPE"
    }'
    https://api.mercadolibre.com/marketplace/seller-promotions/items/$ITEM_ID?user_id=$USER_ID
    

    Example:

    curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' \
      -d '{
         "promotion_id":"P-MLM1806015",
         "promotion_type":"MARKETPLACE_CAMPAIGN"
      }'
      https://api.mercadolibre.com/marketplace/seller-promotions/items/MLM3293401659user_id=1317418851' \
      --header 'version: v2' \
      --header 'X-Client-Id: 1317417907' \
      --header 'X-Caller-Id: 1317417907' \
      

    Response:

    {
      "offer_id": "OFFER-MLM3293401659-177366",
      "price": 700,
      "original_price": 1000
    }

    Parameters

    • deal_id: promotion identification. MARKETPLACE_CAMPAIGN.
    • promotion_type: type of promotion MARKETPLACE_CAMPAIGN.

    Modify items

    Since prices cannot be changed directly, follow the steps below to change the price of an item included in a Co-Founded discount campaign.


    Steps:

    • Delete the item from the campaign.
    • Change item price just like regular price synchronization.
    • Add the item back to the campaign.

    • Note:
      - Since items included in co-funded campaigns (marketplace campaign) have no fixed price, when the price of an included item rises, it will be automatically removed from the offer and you will not be able to add it back.

      Delete items

      Request:

      curl -X DELETE -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/marketplace/seller-promotions/items/$ITEM_ID?promotion_type=$PROMOTION_TYPE&promotion_id=$PROMOTION_ID&offer_id=$OFFER_ID

      Example:

      curl -X DELETE -H 'Authorization: Bearer $ACCESS_TOKEN' 'https://api.mercadolibre.com/marketplace/seller-promotions/items/MLM3293401659?promotion_type=MARKETPLACE_CAMPAIGN&promotion_id=P-MLM379009&offer_id=MLB1834747833-9eafadd4-16d2-49ae-b272-9a7a34585cb8&user_id=1317418851' \
        --header 'version: v2' \
        --header 'X-Client-Id: 1317417907' \
        --header 'X-Caller-Id: 1317417907' \
        

      Response: Status 200 OK


      Next: Pre-negotiated Discount per Item