Logo
Ecartapi.com Public API Documentation

Get all products

GET https://api.ecartapi.com/api/v2/products

This API endpoint makes an HTTP GET request to retrieve a list of products.

Query parameters:

  • productType: This parameter is used to filter the products based on their type.
  • status[active]: This parameter is used to filter the products based on their status, specifically for active products.

Response details:

  • success: A boolean value indicating the success of the request.
  • products: An array of product objects, each containing the following properties:
    • id: The unique identifier of the product.
    • sku: The stock keeping unit (SKU) of the product.
    • name: The name of the product.
    • subName: The subname of the product.
    • upc: The universal product code (UPC) of the product.
    • gtin: The global trade item number (GTIN) of the product.
    • description: The description of the product.
    • currency: The currency used for pricing the product.
    • productType: The type of the product.
    • quantity: The quantity of the product.
    • price: The price of the product.
    • cost: The cost of the product.
    • discount: The discount applied to the product.
    • dimensions: An object representing the dimensions of the product, including width, height, length, and weight.
    • units: An object representing the units of measurement for the product dimensions, including width, height, length, and weight.
    • category: An object representing the category of the product, including the category ID and name.
    • tags: An array of tags associated with the product.
    • status: An object representing the status of the product, including the status ID, visibility, active status, ecartapi ID, ecartapi, and whether the product has options.
    • variants: An array of variant objects associated with the product, each containing properties such as variant ID, product ID, barcode, name, price, currency, fulfillment service, options, dimensions, units, inventory, status, shipping requirements, bundled status, country and province codes, harmonized system code, image ID, image URL, and dates.
    • options: An array of option objects associated with the product, each containing a name and an array of values.
    • associatedItems: An array of associated item objects.
    • logistic: An object representing the logistic details of the product, including ME1 support, mode, type, free shipping, direction, dimensions, and rates.
    • images: An array of image objects associated with the product, each containing an ID, URL, variant IDs, and ecartapi URL.
    • imageUrl: The URL of the product image.
    • condition: The condition of the product.
    • link: The link to the product.
    • dates: An object representing the creation and update dates of the product.
    • vendor: The vendor of the product.
    • sellOutStock: The stock status of the product.
    • locations: An array of location objects associated with the product, each containing properties such as location ID, name, address, country, state, city, postal code, phone number, company, references, product IDs, default status, latitude, longitude, and ecartapi URL.
    • internationalShipment: An array of international shipment objects associated with the product.

Additionally, the response includes a page object with the next property indicating the URL for the next page of results, and the previous property indicating the URL for the previous page of results.

Please note that some properties may have null values depending on the availability of data for each product.

 

Body PARAM

Key Datatype Required Description 
limit
string Limit size of the search. Default 50. Max value allowed 50
searchType
string Get quantity of items greather than 1000 elements
name
string Filter items by name
page
string
Curl
curl -X GET 'https://api.ecartapi.com/api/v2/products?limit=Integer&searchType=String&name=String&page=String (Token)&productType=String&status[active]=Booelan' -H 'Authorization: access_token' -d '{"id":705269519,"nickname":"TEST9JANVRJE","registration_date":"2021-01-22T12:05:49.000-04:00","first_name":"Test","last_name":"Test","gender":"","country_id":"MX","email":"test_user_75820318@testuser.com","identification":{"number":"aaaaaa11111111a111","type":"IFE"},"address":{"address":"1 de Mayo 4","city":"Monterrey","state":"MX-NLE","zip_code":"64220"},"phone":{"area_code":null,"extension":"","number":"9997751243","verified":false},"alternative_phone":{"area_code":"","extension":"","number":"9991238445"},"user_type":"normal","tags":["normal","test_user","mshops","messages_as_seller"],"logo":null,"points":2,"site_id":"MLM","permalink":"http://perfil.mercadolibre.com.mx/TEST9JANVRJE","seller_experience":"NEWBIE","bill_data":{"accept_credit_note":null},"seller_reputation":{"level_id":"1_red","power_seller_status":null,"transactions":{"canceled":3,"completed":15,"period":"historic","ratings":{"negative":0,"neutral":0,"positive":1},"total":18},"metrics":{"sales":{"period":"365 days","completed":15},"claims":{"period":"365 days","rate":0,"value":0},"delayed_handling_time":{"period":"365 days","rate":0.6666,"value":4},"cancellations":{"period":"365 days","rate":0,"value":0}}},"buyer_reputation":{"canceled_transactions":0,"transactions":{"canceled":{"paid":null,"total":null},"completed":null,"not_yet_rated":{"paid":null,"total":null,"units":null},"period":"historic","total":null,"unrated":{"paid":null,"total":null}}},"status":{"billing":{"allow":true},"buy":{"allow":true,"immediate_payment":{"required":false}},"confirmed_email":true,"shopping_cart":{"buy":"allowed","sell":"allowed"},"immediate_payment":false,"list":{"allow":true,"immediate_payment":{"required":false}},"mercadoenvios":"not_accepted","mercadopago_account_type":"personal","mercadopago_tc_accepted":true,"required_action":null,"sell":{"allow":true,"immediate_payment":{"reasons":["low_seller_reputation"],"required":true}},"site_status":"active","user_type":null},"secure_email":"ttest.1t1tg4@mail.mercadolibre.com.mx","company":{"brand_name":null,"city_tax_id":"","corporate_name":"","identification":"","state_tax_id":"","cust_type_id":"CO","soft_descriptor":null},"credit":{"consumed":0,"credit_level_id":"MLM3","rank":"payer"},"context":{"ip_address":"200.0.0.0"},"shipping_modes":{"local_pick_up":false,"modes":["custom","not_specified","me2","me1"],"trusted_user":false,"bulky":false,"custom_calculator":"Axado","picking_type":null,"thermal_printer":null,"option":"in","tags":["lazy_rollout","dsa_confirmed","optional_me1_allowed"],"carrier_pickup":false,"items_combination":"enabled","services":[171,181,511,521,791,811,1071,1081,1161,214722,214723,231876],"logistics":[{"mode":"me1","types":[{"type":"default","services":[231876],"default":true,"status":"active"}]},{"mode":"me2","types":[{"type":"drop_off","services":[171,181,511,521,791,811,1071,1081,1161,214722,214723],"default":true,"status":"active"}]},{"mode":"custom","types":[{"type":"custom","services":null,"default":true,"status":"active"}]},{"mode":"not_specified","types":[{"type":"not_specified","services":null,"default":true,"status":"active"}]}],"label":{"print_danfe":null,"print_browser":null,"print_voucher":true,"print_summary":true,"thermal_printer":null,"page_size":null,"page_format":null},"content_declaration_disabled":false,"mandatory_invoice_data":false,"site_id":"MLM","free_configurations":[{"condition":{"value":null,"type":"all"},"rule":{"default":true,"free_mode":"country","value":null}}]}}'

ENDPOINTS