### Get Orders Response Example Source: https://docs.ventiapp.mx/ventiapp/desarrolladores/api/ventas Example JSON response from the Get Orders endpoint (GET https://ventiapi.azurewebsites.net/api/orders/orders). Shows the structure of an order with items, buyer, and shipping information. Fields marked as optional depend on the sales channel. ```json { "paging": 50, "offset": 0, "total": 2, "sort": "added_desc", "results": [ { "orderId": 1234, "channel": "amazon", "dateAdded": "2018-10-29T00:00:00", "dateCreated":"2018-10-29T00:00:00", "dateModified": "2018-10-29T00:00:00", "externalId": "111444123", "total": 660.0, "currency": "MXN", "tax": 0.16, "comments": "Send it before tuesday", //INFORMACION OPCIONAL (DEPENDE DEL CANAL) "itemsQuantity": 2, "title": "Order Title", "internalStatus": 1, "amazonFulfillment": "MFN", "cartId": "00000101110002", //INFORMACION OPCIONAL (DEPENDE DEL CANAL) "externalNumber" : "12314512", "orderStatus" : "paid", "Discounts": 120.00, "items": [ { "itemExternalId": "MLM3312341", "title": "Item 1", "price": 460.0, "variationId": "13818313",//INFORMACION OPCIONAL (DEPENDE DEL CANAL) "variationName": "Red", //INFORMACION OPCIONAL (DEPENDE DEL CANAL) "itemQuantity": 1, "total": 460.0, "sku": "ITEM-RED001", //SKU DE VENTIAPP "channelSku": "765840000", //SKU DEL CANAL "erpId": null, //INFORMACION OPCIONAL (SOLO PARA INTEGRACIONES CUSTOM) "itemStatus": "returned" //INFORMACION OPCIONAL (DEPENDE DEL CANAL) }, { "itemExternalId": "MLM3317841", "title": "Item 2", "price": 200.0, "variationId": null, //INFORMACION OPCIONAL (DEPENDE DEL CANAL) "variationName": null, //INFORMACION OPCIONAL (DEPENDE DEL CANAL) "itemQuantity": 1, "total": 200.0, "sku": "PLAINITEM001", //SKU DE VENTIAPP "channelSku": "765840001", //SKU DEL CANAL "erpId": null, //INFORMACION OPCIONAL (SOLO PARA INTEGRACIONES CUSTOM) "itemStatus": null //INFORMACION OPCIONAL (DEPENDE DEL CANAL) } ], "buyer": { "name": "John",//INFORMACION OPCIONAL (DEPENDE DEL CANAL) "lastname": "Doe",//INFORMACION OPCIONAL (DEPENDE DEL CANAL) "email": "email@api.com",//INFORMACION OPCIONAL (DEPENDE DEL CANAL) "state": "Distrito Federal",//INFORMACION OPCIONAL (DEPENDE DEL CANAL) "address": "Street Address 123",//INFORMACION OPCIONAL (DEPENDE DEL CANAL) "city": "Mexico City",//INFORMACION OPCIONAL (DEPENDE DEL CANAL) "zipcode": "06700",//INFORMACION OPCIONAL (DEPENDE DEL CANAL) "nickname": "JOHNDOEVENTI",//INFORMACION OPCIONAL (DEPENDE DEL CANAL) "phone": "5584848152",//INFORMACION OPCIONAL (DEPENDE DEL CANAL) "externalId": "551331413",//INFORMACION OPCIONAL (DEPENDE DEL CANAL) "municipality": "cuahutemoc",//INFORMACION OPCIONAL (DEPENDE DEL CANAL) "neigborhood":"roma sur", //INFORMACION OPCIONAL (DEPENDE DEL CANAL), "Comments" : "Dejar al lado de la puerta", "billingInfo": { //INFORMACION FISCAL OPCIONAL(DEPENDE DEL CANAL) "docType": "DNI", "docValue": "123456789" } }, "shipping": { "sellerInfo": "MYSELLERNAME",//INFORMACION OPCIONAL (DEPENDE DEL CANAL) "sellerId": null, //INFORMACION OPCIONAL (DEPENDE DEL CANAL) "shipmentType": "me2", //INFORMACION OPCIONAL (DEPENDE DEL CANAL) } } ] } ``` -------------------------------- ### Add Product Response Example Source: https://docs.ventiapp.mx/ventiapp/english-api/developers/api/productos Example JSON response from the Add Product endpoint, showing a successfully created product with its details. ```json { "productId": 3182093, "sku": "AA123", "price": 99.99, "title": "Olla a presion Gris", "ean": null, "upc": "41123123", "longDescription": "Descripcion larga de prueba", "shortDescription": "Descripción corta de prueba", "baseStock": 66, "images": ["url imagen 1","url imagen 2"], "brand": "Greycon", "weight": 2400, "height": 30, "width": 20, "depth": 20 } ``` -------------------------------- ### Get Price Stock By Channel - Response Example Source: https://docs.ventiapp.mx/ventiapp/desarrolladores/api/stock-y-precios Example 200 response for the GET getpricestockbychannel/{sku}/ endpoint. Shows channelData array with per-channel quantity, price, salePrice, externalId, permalink, and status. ```json { "sku": "ElektraSku1-1", "channelData": [ { "channel": "meli", "quantity": 94, "price": 234.00, "salePrice": null, "externalId": "MLM760079428", "permalink": "http://articulo.mercadolibre.com.mx/MLM-760079428-elektra1-_JM", "status": "under_review" }, { "channel": "wish", "quantity": 0, "price": 234.00, "salePrice": null, "externalId": "", "permalink": null, "status": "unpublished" }, { "channel": "claroshop", "quantity": 0, "price": 234.00, "salePrice": null, "externalId": "", "permalink": null, "status": "unpublished" }, { "channel": "vtex", "quantity": 0, "price": 234.00, "salePrice": null, "externalId": "", "permalink": null, "status": "unpublished" }, { "channel": "liverpool", "quantity": 2, "price": 234.00, "salePrice": null, "externalId": "", "permalink": null, "status": "unpublished" }, { "channel": "walmartedi", "quantity": 2, "price": 234.00, "salePrice": null, "externalId": "", "permalink": null, "status": "unpublished" }, { "channel": "elektra", "quantity": 94, "price": 234.00, "salePrice": null, "externalId": "1624988838125", "permalink": null, "status": "PENDING_APPROVAL" }, { "channel": "woocommerce", "quantity": 94, "price": 234.00, "salePrice": null, "externalId": "", "permalink": "", "status": "unpublished" }, { "channel": "amazonus", "quantity": 2, "price": 234.00, "salePrice": null, "externalId": "", "permalink": null, "status": "unpublished" }, { "channel": "walmartus", "quantity": 2, "price": 234.00, "salePrice": null, "externalId": "", "permalink": null, "status": "unpublished" } ] } ``` -------------------------------- ### 200 OK Response Example Source: https://docs.ventiapp.mx/ventiapp/desarrolladores/api/stock-y-precios Example JSON response for the GetProductsStockPrice endpoint. Shows product SKUs with channel-specific stock, price, salePrice, externalId, permalink, and status. ```json { "offset": 0, "paging": 50, "total": 2, "results": [ { "sku": "0GY", "channelData": [ { "channel": "elektra", "quantity": 1, "price": 2760.00, "salePrice": null, "externalId": "", "permalink": null, "status": "unpublished" }, { "channel": "shopify", "quantity": 2, "price": 2699.00, "salePrice": null, "externalId": "6608400187523", "permalink": "https://kubostore3.myshopify.com/products/mochila-tommy", "status": "active" }, { "channel": "mshops", "quantity": 0, "price": 2760.00, "salePrice": null, "externalId": "MLM1630893194", "permalink": "http://articulo.mercadolibre.com.mx/MLM-1630893194-mochila-tommy-_JM", "status": "paused" } { "channel": "claroshop", "quantity": 1, "price": 2760.00, "salePrice": null, "externalId": "", "permalink": null, "status": "unpublished" }, { "channel": "tiendanube", "quantity": 1, "price": 2760.00, "salePrice": null, "externalId": "", "permalink": null, "status": "unpublished" } ] }, { "sku": "120-3", "channelData": [ { "channel": "elektra", "quantity": 10, "price": 100.00, "salePrice": null, "externalId": "", "permalink": null, "status": "unpublished" }, { "channel": "shopify", "quantity": 146, "price": 100.00, "salePrice": null, "externalId": "7725102137475", "permalink": "https://kubostore3.myshopify.com/products/producto-2", "status": "active" } ] } ] } ``` -------------------------------- ### Example request body for creating a product with variations Source: https://docs.ventiapp.mx/ventiapp/desarrolladores/api/productos Example JSON payload for creating a new product with variations. Includes fields like sku, price, title, images, attributes, and a variations array with up to two combinations (e.g., size and color). ```json { "sku": "PRUEBA01", "price": 199.99, "title": "Artículo de prueba", "listingTitle": "Artículo de prueba", "ean": null, "upc": "41123123", "longDescription": "Descripcion larga de prueba", "shortDescription": "Descripción corta de prueba", "baseStock": 50, "images": ["https://ventiapp.com/images/venti_botapp.png", "https://ventiapp.com/images/logoventi.png"], "brand": "Ventiapp", "model": "MDL01", "weight": 2400, "height": 30, "width": 20, "depth": 20, "packageWeight": 2500, "packageHeight": 34, "packageWidth": 22, "packageDepth": 30, "used": false, "attributes": [ { "id": "GENDER", "value": "Mujer" }, { "id": "FOOTWEAR_TYPE", "value": "Mocasines" } ], "warranty": "2 meses de fabricante", "videoUrl": "https://www.youtube.com/watch?v=1rBJd2w1zdM", "categorySource": "magento", "categorySourceId" : 123, "variations": [{ "sku": "AA123-RED-XL", "ean": null, "upc": "4112312333", "stock": 10, "combinations": [{ "name": "Talla", "value": "XL" }, { "name": "Color", "value": "Rojo" }] }, { "sku": "AA123-RED-M", "ean": null, "upc": "4112312334", "stock": 8, "combinations": [{ "name": "Talla", "value": "M" }, { "name": "Color", "value": "Rojo" }] }, { "sku": "AA123-GREEN-XL", "ean": null, "upc": "4112312335", "stock": 12, "combinations": [{ "name": "Talla", "value": "XL" }, { "name": "Color", "value": "Verde" }] }, { "sku": "AA123-GREEN-M", "ean": null, "upc": "4112312335", "stock": 20, "combinations": [{ "name": "Talla", "value": "M" }, { "name": "Color", "value": "Verde" }] }] } ``` -------------------------------- ### Update Price And Stock Async - Response Example Source: https://docs.ventiapp.mx/ventiapp/desarrolladores/api/stock-y-precios Example response from the Update Price And Stock Async endpoint, indicating the request was sent and providing a jobId. ```json { "status": "sent", "msg": "request sent", "jobId": "9999" } ``` -------------------------------- ### Find Order Response Example Source: https://docs.ventiapp.mx/ventiapp/desarrolladores/api/ventas Example JSON response from the Find Order endpoint showing order details, items, buyer, shipping, and payment methods. Includes optional fields like billingInfo and paymentMethods that depend on the channel. ```json { "paging": 50, "offset": 0, "total": 1, "sort":null, "results": [ { "orderId": 1234, "channel": "meli", "dateAdded": "2018-10-29T00:00:00", "dateModified": "2018-10-29T00:00:00", "externalId": "111444123", "total": 660.0, "currency": "MXN", "tax": 0.16, "comments": "Send it before tuesday", "itemsQuantity": 2, "title": "Order Title", "internalStatus": 1, "amazonFulfillment": "false", "cartId": "00000101110002", "externalNumber" : "12314512", "orderStatus" : "paid", "Discounts":120.00, "externalStatus": "CREATED", "items": [ { "itemExternalId": "MLM3312341", "title": "Item 1", "price": 460.0, "variationId": "13818313", "variationName": "Red", "itemQuantity": 1, "total": 460.0, "sku": "ITEM-RED001", //SKU DE VENTIAPP "channelSku": "765840002", //SKU DEL CANAL "erpId": null, "itemStatus": "returned" }, { "itemExternalId": "MLM3317841", "title": "Item 2", "price": 200.0, "variationId": null, "variationName": null, "itemQuantity": 1, "total": 200.0, "sku": "PLAINITEM001", //SKU DE VENTIAPP "channelSku": "765840001", //SKU DEL CANAL "erpId": null, "itemStatus": null } ], "buyer": { "name": "John", "lastname": "Doe", "email": "email@api.com", "state": "Distrito Federal", "address": "Street Address 123", "city": "Mexico City", "zipcode": "06700", "nickname": "JOHNDOEVENTI", "phone": "5584848152", "externalId": "551331413", "municipality": "cuahutemoc", "neigborhood":"roma sur", "Comments" : "Dejar al lado de la puerta", "billingInfo": { //INFORMACION FISCAL OPCIONAL(DEPENDE DEL CANAL) "docType": "DNI", "docValue": "123456789" } }, "shipping": { "sellerInfo": "MYSELLERNAME", "sellerId": null, "shipmentType": "me2", "shippingStatus": "shipped", "shippingCourier": "drop_off", "shippingId": "27586098188", "shippingType": "me2", "ventiShipping": false, "ventiCourierId": null, "shippingTrackingId": "10003313132", "shippingCourierExternal": "Fedex Express", "shippingReceptor": "Juan Dominguez", "ShippingRealCost": 23.4, "ShipmentChargedTo": "buyer" }, "paymentMethods": [ { "externalId": "5531048951", "paymentMethod": "oxxo" } ], "accountName" : "MY_MELI_USER" } ] } ``` -------------------------------- ### Respuesta de GET /api/listing/getOptions Source: https://docs.ventiapp.mx/ventiapp/desarrolladores/api/publicaciones Ejemplo de respuesta JSON del endpoint GET /api/listing/getOptions. Incluye accountName, listingTypePublish (Premium, Clásica), listingTypeShipping (Mercado Envíos, Personalizado, Mercado Envíos 1) y listingStores vacío. Se usa para obtener las opciones necesarias antes de crear una publicación. ```json { "accountName": "TESTBXXXXX", "listingTypePublish": [ { "id": 1, "name": "Premium" }, { "id": 3, "name": "Clásica" } ], "listingTypeShipping": [ { "name": "Mercado Envíos", "mode": "me2" }, { "name": "Personalizado", "mode": "custom", "options": [ { "id": 1, "name": "Envio Personalizado 1", "cost": 33.5400 }, { "id": 3, "name": "Envio Personalizado 2", "cost": 0.0000 }, { "id": 7, "name": "Envio Personalizado 3", "cost": 93.4500 }, { "id": 37, "name": "Envio Personalizado 4", "cost": 89.0000 }, { "id": 40, "name": "Envio Personalizado 5", "cost": 23.0000 }, { "id": 65, "name": "Envio Personalizado 5", "cost": 455.0000 }, { "id": 69, "name": "Envio Personalizado 6", "cost": 99.9900 } ] }, { "name": "Mercado Envíos 1", "mode": "me1" } ], "listingStores": [] } ``` -------------------------------- ### GET Relationship - Response Example Source: https://docs.ventiapp.mx/ventiapp/desarrolladores/api/productos Example response body for the Get Relationship endpoint. Contains the primary relationship and a list of combinations. ```json { "relationships": "5533936", "combinations": [ "5744938", "5666574" ] } ``` -------------------------------- ### POST /api/listing/create Source: https://docs.ventiapp.mx/ventiapp/desarrolladores/api/publicaciones Crea una nueva publicación en un canal específico. Se requiere al menos uno de los parámetros id o parentSku. ```APIDOC ## POST /api/listing/create ### Description Este método es utilizado para crear una nueva publicación, es necesario que tenga todas las opciones requeridas por el canal. A pesar de que los parámetros id y parentSku son opcionales, al menos uno de los dos debe ser enviado para poder publicar el producto. ### Method POST ### Endpoint https://ventiapi.azurewebsites.net/api/listing/create ### Parameters #### Path Parameters - **channel*** (string) - Requerido - Canal en donde se desea crear la publicación. Valores disponibles: "meli" o "mercadolibre", "shopify", "magento". - **id** (int) - Opcional - Id interno del producto dentro de Ventiapp. - **parentSku** (string) - Opcional - Sku padre del producto. ### Request Example ```json { "sellerId": "234245", "listingTypeId": 1, "listingModeShipping": "me2", "listingCustomShippingId": null, "officialStoreId": null, "freeShipping": false, "localPickup": false, "fulfillment": false, "mshops": false, "sizeChartId": 32321 } ``` ### Response #### Success Response (200) No se proporciona un ejemplo de respuesta en la documentación. ``` -------------------------------- ### GET /api/Listing/GetAllSizeCharts Source: https://docs.ventiapp.mx/ventiapp/desarrolladores/api/publicaciones Obtiene todas las guías de talla creadas por el usuario de la cuenta de Mercado Libre. Devuelve una lista de guías con sus columnas y tallas. ```APIDOC ## GET /api/Listing/GetAllSizeCharts ### Description Obtiene todas las guías de talla creadas por el usuario de la cuenta de Mercado Libre. ### Method GET ### Endpoint https://ventiapi.azurewebsites.net/api/Listing/GetAllSizeCharts ### Response #### Success Response (200) - **integrationSellerId** (string) - Identificador del vendedor integrado. - **sizeCharts** (array) - Lista de guías de talla. - **id** (integer) - Identificador de la guía. - **name** (string) - Nombre de la guía. - **columns** (array) - Columnas de la guía. - **id** (string) - Identificador de la columna. - **name** (string) - Nombre de la columna. - **type** (object) - Tipo de columna. - **id** (string) - Identificador del tipo. - **default_unit** (string) - Unidad por defecto. - **sizes** (array) - Lista de tallas. - **name** (string) - Nombre de la talla. - **measurements** (array) - Medidas de la talla. - **id** (string) - Identificador de la medida. - **value** (number) - Valor de la medida. #### Response Example ```json [ { "integrationSellerId": "346634509", "sizeCharts": [ { "id": 2022143, "name": "guia test", "columns": [ { "id": "CHEST_CIRCUMFERENCE", "name": "Contorno del pecho", "type": { "id": "NUMBER_UNIT", "default_unit": "cm" } } ], "sizes": [ { "name": "30", "measurements": [ { "id": "CHEST_CIRCUMFERENCE", "value": 50.0 } ] }, { "name": "40", "measurements": [ { "id": "CHEST_CIRCUMFERENCE", "value": 50.0 } ] } ] } ] } ] ``` ``` -------------------------------- ### Get Bills Response Example Source: https://docs.ventiapp.mx/ventiapp/english-api/developers/api/facturas Example JSON response from the Get Bills endpoint showing the structure of invoice request data, including paging, offset, total, and results array with order details and customer information. ```json { "paging": 50, "offset": 0, "total": 2, "results": [ { "orderId": 1234, "billingDate": "2018-06-06T00:00:00", "externalReference": "14124141", "externalDate": "2018-06-06T00:00:00", "message": "Billing message", "invoice": "0001", "total": 660.0, "cdfi": "04", "bankDigits": "1234", "paymentMethod": "03", "customer": { "name": "John", "businessName": "Doe", "rfc": "X3XXXXNNX0131", "email": "billing@test.com", "phone": "1139992331", "billingAddress": null, "billingStreet": null, "billingInnerNumber": null, "billingOuterNumber": null, "billingNeighborhood": null, "billingCountry": null, "billingState": null, "billingMunicipality": null, "billingZipCode": null } } ] } ``` -------------------------------- ### GET /api/orders/printlabel/ Source: https://docs.ventiapp.mx/ventiapp/english-api/developers/api/ventas Endpoint to print the shipping guide associated with a sale. It requires either externalId or orderId, and optionally a type (zpl or pdf). ```APIDOC ## [GET] /api/orders/printlabel/ ### Description This method is used to print the guide associated with the sale. When the guide is printed for the first time, the associated marketplace will notify the client that the order is being processed automatically. The **externalId** or **orderId** are mandatory, with one of the two the call is already valid. The **type** field is optional, indicating if it is zpl or pdf (not all channels support ZPL). The default value is pdf. ### Method GET ### Endpoint https://ventiapi.azurewebsites.net/api/orders/printlabel/ ### Parameters #### Query Parameters - **externalId** (string) - Optional - ID externo de la venta (del marketplace o plataforma de ecommerce) - **type** (string) - Optional - Tipo de guía que se desea imprimir - **orderId** (integer) - Optional - ID de Ventiapp ### Response #### Success Response (200) Procede a la descarga del archivo en formato .zpl o .pdf #### Error Response { "message": "the format is not supported by the order" } ``` -------------------------------- ### GET /api/orders/GetShippingByOrder Source: https://docs.ventiapp.mx/ventiapp/desarrolladores/api/ventas Returns the shipping details for a sale. Optionally, it can obtain the shipping label before retrieving the information, which starts the order handling time. ```APIDOC ## GET /api/orders/GetShippingByOrder ### Description Returns the shipping details for a sale. Optionally, it can obtain the shipping label before retrieving the information, which starts the order handling time. ### Method GET ### Endpoint https://ventiapi.azurewebsites.net/api/orders/GetShippingByOrder?orderid=10710930 ### Parameters #### Query Parameters - **orderId** (string) - Required - ID of the sale. - **printLabel** (bool) - Optional - Indicates whether to obtain the shipping label before retrieving its information. Note that this process starts the order handling time. ### Response #### Success Response (200) Returns the shipping details as shown in the example. #### Response Example { "externalId": "CPTEST-07", "items": [ // Las guías de una venta { "externalId": "CPTEST-07", "guideUrl": "http://ventiapp.blob.core.windows.net/files/FE448DF5/GuiaShippingCyberPuerta_13_4_2022_18_54_7_235.pdf.pdf?sp=r&st=2021-03-04T17:03:04Z&se=2072-03-05T01:03:04Z&sv=2020-08-04&sr=c&sig=3fTU042IxoJaBGqKOYi4bnjLAQ1Afen3E2FXw8FGL%2FU%3D", "guideReference": "10003313132", "guideTrackingUrl": null, "courierName": "fedex" } ], "sellerInfo": null, "sellerId": null, "shipmentType": null, "shippingStatus": null, "shippingCourier": null, "shippingId": null, "shippingType": null, "ventiShipping": false, "ventiCourierId": null, "shippingTrackingId": "10003313132", "shippingCourierExternal": "fedex", "shippingCost": null, "fulfillment": "dropshipping", "shippingReceptor": "CyberPuerta", "country": "México", "shippingDiscount": null, "shippingCostPromo": null, "clientCouponAmount": null, "shippingRealCost": null } ``` -------------------------------- ### UpdateErpId Success Response Example Source: https://docs.ventiapp.mx/ventiapp/desarrolladores/api/ventas Example of a successful response from the UpdateErpId endpoint, showing the updated ventaextId, erpId, and a success message. ```json [ { "ventaextId": "2000003508461232104", "erpId": "test", "messageR": "IdERP Updated successful" } ] ``` -------------------------------- ### POST /api/product/addproduct Source: https://docs.ventiapp.mx/ventiapp/english-api/developers/api/productos Creates a base product in Ventiapp. Requires authentication and mandatory fields; otherwise, an error is returned. ```APIDOC ## POST /api/product/addproduct ### Description Creates a base product in Ventiapp. If required fields are not provided, the service will throw an error. ### Method POST ### Endpoint https://ventiapi.azurewebsites.net/api/product/addproduct ### Headers - **Authentication** (string) - Required - Bearer + token ### Request Body - **SKU** (string) - Required - SKU identifier of the product. If not available, it is recommended to use the ERP ID. - **title** (string) - Required - Product title. - **price** (number) - Required - Base price of the product, used when generating a new listing. - **weight** (number) - Required - Product weight in grams. - **height** (number) - Required - Product height in centimeters. - **width** (number) - Required - Product width in centimeters. - **depth** (number) - Required - Product depth in centimeters. - **brand** (string) - Optional - Product brand. - **EAN** (string) - Optional - EAN13 identifier of the product. - **UPC** (string) - Optional - UPC identifier of the product. - **longDescription** (string) - Optional - Long description of the product (default). - **shortDescription** (string) - Optional - Short description of the product. - **baseStock** (integer) - Optional - Base inventory quantity, used when generating a new listing. - **images** (array) - Optional - Array of strings with image URLs. ### Request Example { "productId": 3182093, "sku": "AA123", "price": 99.99, "title": "Olla a presion Gris", "ean": null, "upc": "41123123", "longDescription": "Descripcion larga de prueba", "shortDescription": "Descripción corta de prueba", "baseStock": 66, "images": ["url imagen 1","url imagen 2"], "brand": "Greycon", "weight": 2400, "height": 30, "width": 20, "depth": 20 } ### Response #### Success Response (200) - **productId** (integer) - ID of the created product. - **sku** (string) - SKU of the product. - **price** (number) - Price of the product. - **title** (string) - Title of the product. - **ean** (string|null) - EAN identifier. - **upc** (string) - UPC identifier. - **longDescription** (string) - Long description. - **shortDescription** (string) - Short description. - **baseStock** (integer) - Base stock. - **images** (array) - Array of image URLs. - **brand** (string) - Brand. - **weight** (number) - Weight in grams. - **height** (number) - Height in cm. - **width** (number) - Width in cm. - **depth** (number) - Depth in cm. #### Response Example { "productId": 3182093, "sku": "AA123", "price": 99.99, "title": "Olla a presion Gris", "ean": null, "upc": "41123123", "longDescription": "Descripcion larga de prueba", "shortDescription": "Descripción corta de prueba", "baseStock": 66, "images": ["url imagen 1","url imagen 2"], "brand": "Greycon", "weight": 2400, "height": 30, "width": 20, "depth": 20 } ``` -------------------------------- ### Update Order - Request Body Example Source: https://docs.ventiapp.mx/ventiapp/desarrolladores/api/ventas Example JSON body for updating an order. All fields are optional; omitted fields are ignored. ```json { "channel": "your_channel", "externalId": "111444123", "total": 660.0, "currency": "MXN", "tax": 0.16, "comments": "Send it before tuesday", "title": "Order Title", "cartId": "00000101110002", "externalNumber": "12314512", "items": [{ "itemExternalId": "MLM3312341", "title": "Item 1", "price": 460.0, "itemQuantity": 1, "total": 460.0, "sku": "ITEM-RED001", "erpId": "ITEM-123" }, { "itemExternalId": "MLM3317841", "title": "Item 2", "price": 200.0, "itemQuantity": 1, "total": 200.0, "sku": "PLAINITEM001", "erpId": "ITEM-456" } ], "buyer": { "name": "John", "lastname": "Doe", "email": "email@api.com", "state": "Distrito Federal", "address": "Street Address 123", "city": "Mexico City", "zipcode": "06700", "nickname": "JOHNDOEVENTI", "phone": "5584848152", "externalId": "551331413" }, "shipping": { "sellerInfo": "MYSELLERNAME", "sellerId": "MYSELLERID", "shipmentType": "Express", "shippingStatus": "shipped", "shippingCourier": "drop_off", "shippingId": "27586098188", "shippingTrackingId": "10003313132", "shippingCourierExternal": "Fedex Express" } ``` -------------------------------- ### List Products - Success Response Source: https://docs.ventiapp.mx/ventiapp/desarrolladores/api/productos Example of a successful response when listing products. Returns a paginated list with product details such as product ID, SKU, price, title, and images. ```json { "paging": 50, "offset": 0, "count": 1, "results": [ { "productoId": 3392131, "sku": "ClonBolso", "price": 1140.0000, "title": "Bolso WESTIES Satchel rojo HBBIBBUL7WE", "ean": null, "upc": "7501768720689", "longDescription": "


", "shortDescription": null, "baseStock": 1, "images": [ "https://ventiapp.blob.core.windows.net/images/A038C991/39f739bc.jpg" ], "brand": "Westies", "model": null, "weight": null, "height": null, "width": null, "depth": null, "packageWeight": 700.0, "packageHeight": 27.0, "packageWidth": 12.0, "packageDepth": 32.0, "used": false, "warranty": null, "videoUrl": null, "variations": [], "categorySource": null, "categorySourceId": null, "attributes": null } ] } ``` -------------------------------- ### GET /api/listing/getOptions Source: https://docs.ventiapp.mx/ventiapp/desarrolladores/api/publicaciones Retrieves the available options for creating a publication. These options are required before proceeding to the Listing Create step. Currently supports Mercado Libre channel. ```APIDOC ## GET /api/listing/getOptions ### Description This method provides the available options for creating a publication. Without these options, you cannot continue to the Listing Create step. ### Method GET ### Endpoint https://ventiapi.azurewebsites.net/api/listing/getOptions ### Parameters #### Path Parameters - **Seller** (string) - Optional - Seller ID - **ParentSku** (string) - Required - Parent SKU - **Channel** (string) - Required - Channel name (i.e: meli, mercadolibre) #### Headers - **Authorization** (string) - Required - Bearer + token - **Content-Type** (string) - Required - application/json ### Response #### Success Response (200) - **accountName** (string) - Account name - **listingTypePublish** (array) - List of publication types (e.g., Premium, Clásica) - **listingTypeShipping** (array) - List of shipping types (e.g., Mercado Envíos, Personalizado) - **listingStores** (array) - List of stores #### Response Example ```json { "accountName": "TESTBXXXXX", "listingTypePublish": [ { "id": 1, "name": "Premium" }, { "id": 3, "name": "Clásica" } ], "listingTypeShipping": [ { "name": "Mercado Envíos", "mode": "me2" }, { "name": "Personalizado", "mode": "custom", "options": [ { "id": 1, "name": "Envio Personalizado 1", "cost": 33.5400 }, { "id": 3, "name": "Envio Personalizado 2", "cost": 0.0000 }, { "id": 7, "name": "Envio Personalizado 3", "cost": 93.4500 }, { "id": 37, "name": "Envio Personalizado 4", "cost": 89.0000 }, { "id": 40, "name": "Envio Personalizado 5", "cost": 23.0000 }, { "id": 65, "name": "Envio Personalizado 5", "cost": 455.0000 }, { "id": 69, "name": "Envio Personalizado 6", "cost": 99.9900 } ] }, { "name": "Mercado Envíos 1", "mode": "me1" } ], "listingStores": [] } ``` ``` -------------------------------- ### Update Shipping Status - Response Example Source: https://docs.ventiapp.mx/ventiapp/desarrolladores/api/ventas Example response for the update shipping status endpoint. Returns a success message and the order ID. ```json { "message": "shipping status updated successfully", "orderId": "1231256" } ``` -------------------------------- ### Example Request Body for Update Product Source: https://docs.ventiapp.mx/ventiapp/desarrolladores/api/productos Example of a request body to update an existing product. It includes fields like sku, price, title, listingTitle, ean, upc, longDescription, shortDescription, baseStock, images, brand, model, weight, height, width, depth, packageWeight, packageHeight, packageWidth, packageDepth, used, warranty, videoUrl, categorySource, categorySourceId, OverrideImages, attributes, and productPicturesAttributes. ```json { "sku": "PRUEBA01", "price": 199.99, "title": "Artículo de prueba", "listingTitle": "Artículo de prueba", "ean": null, "upc": "41123123", "longDescription": "Descripcion larga de prueba", "shortDescription": "Descripción corta de prueba", "baseStock": 50, "images": ["https://ventiapp.com/images/venti_botapp.png", "https://ventiapp.com/images/logoventi.png"], "brand": "Ventiapp", "model": "MDL01", "weight": 2400, "height": 30, "width": 20, "depth": 20, "packageWeight": 2500, "packageHeight": 34, "packageWidth": 22, "packageDepth": 30, "used": false, "warranty": "2 meses de fabricante", "videoUrl": "https://www.youtube.com/watch?v=1rBJd2w1zdM", "categorySource": "magento", "categorySourceId" : 123, "OverrideImages": false, "attributes": [ { "id": "GENDER", "value": "Mujer" }, { "id": "FOOTWEAR_TYPE", "value": "Mocasines" } ], "productPicturesAttributes": [ { "stringBase64": ```