openapi: 3.0.0 info: title: VTex Marketplace Protocol description: "\r\nThe _Marketplace Protocol_ is a set of API requests and definitions to help you integrate external sellers into a VTEX marketplace as well as external marketplaces into VTEX sellers.\r\n\r\n## External Seller\r\n\r\nHere you will find the endpoints involved in the integration between a VTEX marketplace and an external seller. Note that some of these requests are typically sent by the seller while others are received.\r\n\r\n| **Request** | **From** | **To** |\r\n|-|-|-|\r\n| [Fulfillment simulation](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment#post-/pvt/orderForms/simulation) | Marketplace | Seller |\r\n| [Order placement](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment#post-/pvt/orders) | Marketplace | Seller |\r\n| [Authorize fulfillment](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment#post-/pvt/orders/-sellerOrderId-/fulfill) | Marketplace | Seller |\r\n| [Marketplace order cancellation](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment#post-/pvt/orders/-orderId-/cancel) | Marketplace | Seller |\r\n| [Send invoice](https://developers.vtex.com/docs/api-reference/marketplace-protocol#post-/pvt/orders/-marketplaceOrderId-/invoice) | Seller | Marketplace |\r\n| [Send tracking information](https://developers.vtex.com/docs/api-reference/marketplace-protocol#post-/pvt/orders/-marketplaceOrderId-/invoice/-invoiceNumber-) | Seller | Marketplace |\r\n| [Update tracking status](https://developers.vtex.com/docs/api-reference/marketplace-protocol#post-/pvt/orders/-marketplaceOrderId-/invoice/-invoiceNumber-/tracking) | Seller | Marketplace |\r\n| [Cancel order in marketplace](https://developers.vtex.com/docs/api-reference/marketplace-protocol#post-/pvt/orders/-marketplaceOrderId-/cancel) | Seller | Marketplace |\r\n\r\nFor a detailed explanation of the steps required to develop a custom connector to sell products from an external seller in your storefront, check out our complete [External Seller Integration Guide](https://developers.vtex.com/docs/guides/external-seller-integration-guide).\r\n\r\n\r\n## External Marketplace\r\n\r\nIn this section, you will find the endpoints involved in the VTEX integration between an external marketplace and a VTEX seller.\r\n\r\n\r\n| **Request** | **From** | **To** |\r\n|-|-|-|\r\n| [VTEX Mapper Registration](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper#post-/api/mkp-category-mapper/connector/register) | External marketplace | VTEX system |\r\n| [Send Category Mapping to VTEX Mapper](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper#post-/api/mkp-category-mapper/categories/marketplace/-id-) | External marketplace | VTEX system |\r\n| [New Order Integration](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders#post-/api/order-integration/orders) | External marketplace | VTEX system |\r\n| [Update Order Status](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders#put-/api/order-integration/orders/status) | External marketplace | VTEX system |\r\n| [Fulfillment simulation - External Marketplace](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders#post-/api/checkout/pub/orderForms/simulation) | External marketplace | VTEX system |\r\n| [Place fulfillment order](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders#post-/api/fulfillment/pvt/orders) | External marketplace | VTEX Seller |\r\n| [Authorize dispatch for fulfillment order](https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders#post-/api/fulfillment/pvt/orders/-orderId-/fulfill) | External marketplace | VTEX Seller |\r\n\r\n\r\nFor a detailed explanation of the steps required to develop a custom connector to become an external marketplace for VTEX sellers, check out our complete [External Marketplace Integration Guide](https://developers.vtex.com/docs/guides/external-marketplace-integration-guide)." contact: {} version: '1.0' servers: - url: https://portal.{environment}.com.br description: Server URL. variables: environment: description: Environment to use. Used as part of the URL. enum: - vtexcommercestable default: vtexcommercestable paths: /api/channel-manager/channel/all: get: tags: - External Marketplace summary: VTex List all channels description: This request returns a list of channels available channels with their respective IDs for partners external to VTEX. operationId: list-all-channels parameters: - name: enviroment in: path description: Environment used as part of the URL. required: true style: simple schema: type: string example: portal.vtexcommercestable.com.br - name: an in: query description: VTEX's account name owned by the connector/partner. required: true style: form schema: type: string example: accountName - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: Content-type in: header description: Describes the type of the content being sent. required: true style: simple schema: type: string default: application/json responses: '200': description: OK headers: {} content: application/json: schema: title: Response body description: Expected response body from List all channels. type: object required: - id - name properties: id: title: 'Id ' description: The channel id. type: integer example: 1 name: title: Name description: The channel name. type: string example: Mercado Livre example: id: 1 name: Mercado Livre deprecated: false /api/channel-manager/channel/:channelId: get: tags: - External Marketplace summary: VTex Retrieve channel description: Retrieves a specific channel that already exists in Channel Manager. operationId: retrieve-channel parameters: - name: enviroment in: path description: Environment used as part of the URL. required: true style: simple schema: type: string example: portal.vtexcommercestable.com.br - name: an in: query description: VTEX's account name owned by the connector/partner. required: true style: form schema: type: string example: accountName - name: channelId in: path description: Channel's ID in Channel Manager, available through the List All Channels endpoint. required: true style: simple schema: type: number example: 1 - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: Content-type in: header description: Describes the type of the content being sent. required: true style: simple schema: type: string default: application/json responses: '200': description: OK headers: {} content: application/json: schema: type: object title: '' description: Expected response body from List all channels. required: - id - name properties: id: title: 'Id ' description: The channel id. type: integer example: 1 name: title: Name description: The channel name. type: string example: Mercado Livre example: id: 1 name: Mercado Livre /api/mkp-category-mapper/connector/register: post: tags: - External Marketplace summary: VTEX Mapper Registration description: |- Mappes categories guarantees that the VTEX category tree has a correct association with the marketplace’s category tree. To perform this association, VTEX made VTEX Mapper available. It is a tool integrated into the VTEX platform that allows the user to relate categories created in VTEX to categories from the marketplace. This endpoint allows connectors to register the external marketplace integration in VTEX Mapper. In case VTEX Mapper detects an error and the call fails, the connector should check if mandatory information was sent correctly. Ex. Are URLs correctly registered in the properties `categoryTreeEndPoint` and `mappingEndPoint`? For a detailed explanation of the steps required to develop a custom connector to become an external marketplace for VTEX sellers, check out our complete [External Marketplace Integration Guide](https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-guide). operationId: vtex-mapper-registration parameters: - name: an in: query description: Name of the VTEX account. Used as part of the URL. required: true style: form schema: type: string example: accountName - name: Content-Type in: header description: Describes the type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/VtexMapperRegistration' required: true responses: '200': description: OK headers: {} deprecated: false /api/mkp-category-mapper/categories/marketplace/{id}: post: tags: - External Marketplace summary: Send Category Mapping to VTEX Mapper description: |- Mappes categories guarantees that the VTEX category tree has a correct association with the marketplace’s category tree. To perform this association, VTEX made VTEX Mapper available. It is a tool integrated into the VTEX platform that allows the user to relate categories created in VTEX to categories from the marketplace. This endpoint allows connectors to send the marketplace's category tree mapped in the integration. Connectors should send the payload compacted in `.gzip` format. For a detailed explanation of the steps required to develop a custom connector to become an external marketplace for VTEX sellers, check out our complete [External Marketplace Integration Guide](https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-guide). operationId: send-category-mapping-vtex-mapper parameters: - name: Content-Type in: header description: Describes the type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: id in: path description: Code identifying returned in the *VTEX Mapper Registration* endpoint. required: true style: simple schema: type: string default: '123456789' requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/sendCategoryMappingToVtexMapper' required: true responses: '200': description: OK headers: {} deprecated: false /api/channel-manager/connector: post: tags: - External Marketplace summary: VTex Register connector description: "Registers a new connector in our platform. The account name informed in the request should be the one owned by the partner since it is the only account that will have permission to update or delete the connector.\r\n\r\nPossible values for field `type`:\r\n\r\n- `APP`, if using our App Template.\r\n- `EXTERNAL`, if not using App Template.\r\n\r\nPossible values for field `segment`:\r\n\r\n- `ADS`\r\n- `APPAREL_ACCESSORIES`\r\n- `BEAUTY_HEALTH`\r\n- `BOOKS_EDUCATION`\r\n- `CARS_AUTOPARTS`\r\n- `DEPARTMENT_STORES`\r\n- `ELETRONICS`\r\n- `FINANCIAL_INSURANCES`\r\n- `FOOD_BEVERAGES`\r\n- `GROCERY`\r\n- `HOME_APPLIANCES`\r\n- `HOME_FURNITURE_DECOR`\r\n- `JEWELRY`\r\n- `PET_SHOP`\r\n- `SPORTS_FITNESS`\r\n- `TOURISM`\r\n- `TOYS_HOBBIES`\r\n- `OTHERS`" operationId: register-connector parameters: - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: Content-Type in: header description: Describes the type of the content being sent. required: true style: simple schema: type: string default: application/json - name: environment in: path description: Environment used as part of URL. required: true style: simple schema: type: string example: https://portal.vtexcommercestable.com.br - name: an in: query description: VTEX's account name owned by the connector/partner, ex. `apiexemple` required: true style: form schema: type: string example: apiexemple requestBody: description: Body of the request to execute the Resgister connector. content: application/json: schema: required: - name - website - logo - description - segment - availableCountries - type - isActive - helpUrl - connectorVtexAdminPath - connectorPageUrl - connectorApiEndpoint - channelId properties: name: type: string title: name example: Mercado Livre Classic website: type: string title: website example: mercadolivre.com.br logo: type: string title: logo example: https://g.foolcdn.com/art/companylogos/square/meli.png description: type: string title: description example: MercadoLibre operates online commerce platforms in Latin America. It operates Mercado Libre Marketplace, an automated online commerce platform that enables businesses, merchants, and individuals to list merchandise and conduct sales and purchases online. segment: type: string title: segment example: OTHERS availableCountries: type: array title: availableCountries items: type: string title: Countries example: BRA example: - BRA - ARG type: type: string title: type example: EXTERNAL isActive: type: boolean title: isActive example: true helpUrl: type: string title: helpUrl example: https://help.vtex.com/pt/tracks/configurar-integracao-do-mercado-livre--2YfvI3Jxe0CGIKoWIGQEIq connectorVtexAdminPath: type: string title: connectorVtexAdminPath example: /bridge/#/settings?openConfig=mercadolivre connectorPageUrl: type: string title: connectorPageUrl example: https://apps.vtex.com/vtexbr-tiktok-tbp/p connectorApiEndpoint: type: string title: connectorApiEndpoint example: portal.vtexcommercestable.com/api/meliintegration/notifications channelId: type: integer title: channelId example: 1 example: - name: Mercado Livre Classic website: mercadolivre.com.br logo: https://g.foolcdn.com/art/companylogos/square/meli.png description: MercadoLibre operates online commerce platforms in Latin America. It operates Mercado Libre Marketplace, an automated online commerce platform that enables businesses, merchants, and individuals to list merchandise and conduct sales and purchases online. segment: OTHERS availableCountries: - BRA - ARG type: EXTERNAL isActive: true helpUrl: https://help.vtex.com/pt/tracks/configurar-integracao-do-mercado-livre--2YfvI3Jxe0CGIKoWIGQEIq connectorVtexAdminPath: /bridge/#/settings?openConfig=mercadolivre connectorPageUrl: https://apps.vtex.com/vtexbr-tiktok-tbp/p connectorApiEndpoint: portal.vtexcommercestable.com/api/meliintegration/notifications channelId: 1 responses: '200': description: OK headers: {} content: application/json: schema: type: object title: Response body required: - id - name - website - logo - description - helpUrl - segment - availableCountries - availableStates - type - connectorPageUrl - connectorVtexAdminPath - connectorApiEndpoint - channelId - isGloballyAvailable - ownerVtexAccount - isActive - isCertified - contactInfo - isConnectionActive - affiliateId properties: id: type: integer title: id example: 584 name: type: string title: name example: Mercado Livre Classic website: type: string title: website example: mercadolivre.com.br logo: type: string title: logo example: https://g.foolcdn.com/art/companylogos/square/meli.png description: type: string title: description example: MercadoLibre operates online commerce platforms in Latin America. It operates Mercado Libre Marketplace, an automated online commerce platform that enables businesses, merchants, and individuals to list merchandise and conduct sales and purchases online. helpUrl: type: string title: helpUrl example: https://help.vtex.com/pt/tracks/configurar-integracao-do-mercado-livre--2YfvI3Jxe0CGIKoWIGQEIq segment: type: string title: segment example: OTHERS availableCountries: type: array title: availableCountries items: type: string title: A Schema example: BRA example: - BRA - ARG availableStates: type: array title: availableStates items: {} example: - [] type: type: string title: type example: EXTERNAL connectorPageUrl: type: string title: connectorPageUrl example: https://apps.vtex.com/vtexbr-tiktok-tbp/p connectorVtexAdminPath: type: string title: connectorVtexAdminPath example: /bridge/#/settings?openConfig=mercadolivre connectorApiEndpoint: type: string title: connectorApiEndpoint example: portal.vtexcommercestable.com/api/meliintegration/notifications channelId: type: integer title: channelId example: 1 isGloballyAvailable: type: boolean title: isGloballyAvailable example: false ownerVtexAccount: type: string title: ownerVtexAccount example: vtex isActive: type: boolean title: isActive example: true isCertified: type: boolean title: isCertified example: false contactInfo: type: object title: contactInfo required: - name - email - phone - defaultMessage properties: name: type: string title: name example: Jhon email: type: string title: email example: jhon@marketplace.com phone: type: string title: phone example: (77) 7777-7777 defaultMessage: type: string title: defaultMessage example: '' example: name: Jhon email: jhon@marketplace.com phone: (77) 7777-7777 defaultMessage: '' isConnectionActive: type: boolean title: isConnectionActive example: false affiliateId: type: string title: affiliateId example: '1234' example: id: 584 name: Mercado Livre Classic website: mercadolivre.com.br logo: https://g.foolcdn.com/art/companylogos/square/meli.png description: MercadoLibre operates online commerce platforms in Latin America. It operates Mercado Libre Marketplace, an automated online commerce platform that enables businesses, merchants, and individuals to list merchandise and conduct sales and purchases online. helpUrl: https://help.vtex.com/pt/tracks/configurar-integracao-do-mercado-livre--2YfvI3Jxe0CGIKoWIGQEIq segment: OTHERS availableCountries: - BRA - ARG availableStates: [] type: EXTERNAL connectorPageUrl: https://apps.vtex.com/vtexbr-tiktok-tbp/p connectorVtexAdminPath: /bridge/#/settings?openConfig=mercadolivre connectorApiEndpoint: portal.vtexcommercestable.com/api/meliintegration/notifications channelId: 1 isGloballyAvailable: false ownerVtexAccount: vtex isActive: true isCertified: false contactInfo: name: Jhon email: jhon@marketplace.com phone: (77) 7777-7777 defaultMessage: '' isConnectionActive: false affiliateId: '1234' deprecated: false /api/channel-manager/connector/all: get: tags: - External Marketplace summary: VTex List all connectors description: Returns a paginated list of all connectors' registered in Channel Manager, taking into consideration the filters informed in the query string of the request. operationId: list-all-connectors parameters: - name: environment in: path description: Environment used as part of URL. required: true style: simple schema: type: string example: https://portal.vtexcommercestable.com.br - name: an in: query description: Merchant's account name in VTEX, ex. `apiexemple`. required: true style: form schema: type: string example: apiexemple - name: segment in: query description: Filter data by connector's segment. required: false style: form schema: type: string example: department_stores - name: orderByConnectorType in: query description: Order data using a custom logic by connector's' type, and not alphabetically. required: false style: form schema: type: string example: 'true' - name: active in: query description: Filter data by the connector's status. required: false style: form schema: type: string example: 'true' - name: name in: query description: Filter data by the connector's name. required: false style: form schema: type: string example: Dafiti - name: page in: query description: Current page to load data from. required: false style: form schema: type: integer example: 1 - name: pageSize in: query description: Page size to define number of results returned. required: true style: form schema: type: integer example: 15 - name: country in: query description: Filter by connector's country. required: false style: form schema: type: string example: bra - name: type in: query description: Filter by connector's type. required: false style: form schema: type: string example: vtex - name: account in: query description: Filter by connector's owner account. required: false style: form schema: type: string example: cea - name: accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: content-type in: header description: Describes the type of the content being sent. required: true style: simple schema: type: string default: application/json responses: '200': description: OK headers: {} content: application/json: schema: title: Response body description: Expected success response from List all connector API. type: object required: - metadata - results properties: metadata: title: metadata description: Summary of data returned by the query. type: object required: - totalCount - currentPage - pageSize - totalPages properties: totalCount: title: totalCount description: Total data returned. type: number example: 493 currentPage: title: currentPage description: Current result page. type: number example: 1 pageSize: title: pageSize description: How many results will be displayed per page. type: number example: 5 totalPages: title: totalPages description: Total pages the query returned. type: number example: 99 example: totalCount: 493 currentPage: 1 pageSize: 5 totalPages: 99 results: title: results description: Query result with information for each connector. type: array items: title: '' description: '' type: object required: - id - name - website - logo - description - helpUrl - segment - availableCountries - availableStates - type - connectorPageUrl - connectorVtexAdminPath - connectorApiEndpoint - channelId - isGloballyAvailable - ownerVtexAccount - isActive - isCertified - contactInfo - isConnectionActive - affiliateId properties: id: title: id description: Connector Id. type: number example: 59 name: title: name description: Connecto's name. type: string example: 4R Comercial Sao Paulo website: title: website description: Connector's Website. type: string example: www.comercialsaopaulo.com logo: title: logo description: Logo used by the connector. type: string example: https://comercialsaopaulo.vtexassets.com/assets/vtex.file-manager-graphql/logo/619f6f7f-bf67-4ed1-a15a-282b51f81e06___cd0426736f2550559c8688de3378681f.jpg description: title: description description: Connector presentation. type: string example: |- Somo uma empresa sedeada em Barreiras - BA, decidimos entrar no mundo do E Commerce e marketplace há alguns anos, pois já estávamos estabelecidos e sólidos com a nossa loja física em nossa cidade. Hoje trabalhamos com um portfólio bem diversificado de produtos, que são eles: - Linha à bateria - Lazer e esporte - Camping - Ferramentas elétricas - Maquinários leves e pesados - Ferramentas manuais - E muitos outros segmentos Sua helpUrl: title: helpUrl description: URL to connector integration page. type: string example: help.vtex.com segment: title: segment description: Market segment. type: string example: DEPARTMENT_STORES availableCountries: title: availableCountries description: Countries in which connector is available for integration. type: array items: title: availableCountries description: '' type: string example: BRA example: - BRA availableStates: title: availableStates description: Connector actuation states, valid only for connectors that have range restriction. type: array items: {} example: - [] type: title: type description: What type of connector, if it is native, VTEX or partner. type: string example: VTEX connectorPageUrl: title: connectorPageUrl description: URL where the merchant will be redirected to start the onboarding process. type: string example: https://connector.com/connector connectorVtexAdminPath: title: connectorVtexAdminPath description: Admin VTEX URL, where the merchant will be redirected to manage and view his connections after integration. type: string example: https://connector.com/connector connectorApiEndpoint: title: connectorApiEndpoint description: Partner Connector API base URL. type: string example: https://connector.com/connector channelId: title: channelId description: ID of the channel that a connector joins to. type: string example: '1234' isGloballyAvailable: title: isGloballyAvailable description: In which version the connector is available. type: boolean example: false ownerVtexAccount: title: ownerVtexAccount description: Connector account name in VTEX. type: string example: comercialsaopaulo isActive: title: isActive description: Demonstrates the status of integration with the connector. type: boolean example: false isCertified: title: isCertified description: Demonstrates Demonstrates if the connector is certified. type: boolean example: true contactInfo: title: contactInfo description: Seller contact information. type: object required: - name - email - phone - defaultMessage properties: name: title: name description: Name of the person responsible for the marketplace account interested in connecting to the merchant. type: string example: Jhon Jones email: title: email description: Email of the person responsible for the marketplace account interested in connecting to the merchant. type: string example: comersialsp@comercialsaopaulo.com phone: title: phone description: Phone of the person responsible for the marketplace account interested in connecting to the merchant. type: string example: (77) 7777-7777 defaultMessage: title: defaultMessage description: Introduction message and information of interest in the partnership with the merchant. type: string example: |- Olá, aqui é (...) da (...). Adoraríamos incluir sua loja em nossa vitrine, pois acreditamos que (...). Seguem algumas informações importantes para darmos seguimento à nossa parceria: 1) Nosso marketplace conta com as categorias - A - B - C 2) Nossa política de cobrança inclui uma taxa de (...) para cada compra, mais assinatura fixa de (...) por mês. 3) Saiba mais sobre nossa política de devoluções e envio neste link (...). example: name: Jhon Jones email: comercialsp@comercialsaopaulo.com phone: (77) 7777-7777 defaultMessage: |- Olá, aqui é (...) da (...). Adoraríamos incluir sua loja em nossa vitrine, pois acreditamos que (...). Seguem algumas informações importantes para darmos seguimento à nossa parceria: 1) Nosso marketplace conta as categorias - A - B - C 2) Nossa política de cobrança inclui uma taxa de (...) para cada compra, mais assinatura fixa de (...) por mês. 3) Saiba mais sobre nossa política de devoluções e envio neste link (...). isConnectionActive: title: isConnectionActive description: '' type: boolean example: false affiliateId: title: affiliateId description: affiliate Id connector. type: string example: '1234' example: id: 59 name: 4R Comercial Sao Paulo website: www.comercialsaopaulo.com logo: https://comercialsaopaulo.vtexassets.com/assets/vtex.file-manager-graphql/logo/619f6f7f-bf67-4ed1-a15a-282b51f81e06___cd0426736f2550559c8688de3378681f.jpg description: |- Somo uma empresa sedeada em Barreiras - BA, decidimos entrar no mundo do E Commerce e marketplace há alguns anos, pois já estávamos estabelecidos e sólidos com a nossa loja física em nossa cidade. Hoje trabalhamos com um portfólio bem diversificado de produtos, que são eles: - Linha à bateria - Lazer e esporte - Camping - Ferramentas elétricas - Maquinários leves e pesados - Ferramentas manuais - E muitos outros segmentos Sua helpUrl: help.vtex.com/helpurl segment: DEPARTMENT_STORES availableCountries: - BRA availableStates: [] type: VTEX connectorPageUrl: conector.com/connectorPageUrl connectorVtexAdminPath: connector.com/connectorVtexAdminPath connectorApiEndpoint: connector.com/connectorApiEndpoint channelId: '1234' isGloballyAvailable: false ownerVtexAccount: comercialsaopaulo isActive: false isCertified: true contactInfo: name: Jhon Jones email: comercialsp@comercialsaopaulo.com phone: (77) 7777-7777 defaultMessage: |- Olá, aqui é (...) da (...). Adoraríamos incluir sua loja em nossa vitrine, pois acreditamos que (...). Seguem algumas informações importantes para darmos seguimento à nossa parceria: 1) Nosso marketplace conta as categorias - A - B - C 2) Nossa política de cobrança inclui uma taxa de (...) para cada compra, mais assinatura fixa de (...) por mês. 3) Saiba mais sobre nossa política de devoluções e envio neste link (...). isConnectionActive: false affiliateId: '1234' example: - id: 59 name: 4R Comercial Sao Paulo website: www.comercialsaopaulo.com logo: https://comercialsaopaulo.vtexassets.com/assets/vtex.file-manager-graphql/logo/619f6f7f-bf67-4ed1-a15a-282b51f81e06___cd0426736f2550559c8688de3378681f.jpg description: |- Somo uma empresa sedeada em Barreiras - BA, decidimos entrar no mundo do E Commerce e marketplace há alguns anos, pois já estávamos estabelecidos e sólidos com a nossa loja física em nossa cidade. Hoje trabalhamos com um portfólio bem diversificado de produtos, que são eles: - Linha à bateria - Lazer e esporte - Camping - Ferramentas elétricas - Maquinários leves e pesados - Ferramentas manuais - E muitos outros segmentos Sua helpUrl: help.vtex.com/helpurl segment: DEPARTMENT_STORES availableCountries: - BRA availableStates: [] type: VTEX connectorPageUrl: connector.com/connectorPageUrl connectorVtexAdminPath: connector.com/connectorVtexAdminPath connectorApiEndpoint: connector.com/connectorApiEndpoint channelId: '1234' isGloballyAvailable: false ownerVtexAccount: comercialsaopaulo isActive: false isCertified: true contactInfo: name: Jhon email: contato@comercial.com phone: (77) 7777-7777 defaultMessage: |- Olá, aqui é (...) da (...). Adoraríamos incluir sua loja em nossa vitrine, pois acreditamos que (...). Seguem algumas informações importantes para darmos seguimento à nossa parceria: 1) Nosso marketplace conta as categorias - A - B - C 2) Nossa política de cobrança inclui uma taxa de (...) para cada compra, mais assinatura fixa de (...) por mês. 3) Saiba mais sobre nossa política de devoluções e envio neste link (...). isConnectionActive: false affiliateId: '1234' example: metadata: totalCount: 513 currentPage: 1 pageSize: 15 totalPages: 35 results: - id: 59 name: 4R Comercial Sao Paulo website: www.comercialsaopaulo.com logo: https://comercialsaopaulo.vtexassets.com/assets/vtex.file-manager-graphql/logo/619f6f7f-bf67-4ed1-a15a-282b51f81e06___cd0426736f2550559c8688de3378681f.jpg description: |- Somo uma empresa sedeada em Barreiras - BA, decidimos entrar no mundo do E Commerce e marketplace há alguns anos, pois já estávamos estabelecidos e sólidos com a nossa loja física em nossa cidade. Hoje trabalhamos com um portfólio bem diversificado de produtos, que são eles: - Linha à bateria - Lazer e esporte - Camping - Ferramentas elétricas - Maquinários leves e pesados - Ferramentas manuais - E muitos outros segmentos Sua helpUrl: help.vtex.com/helpurl segment: DEPARTMENT_STORES availableCountries: - BRA availableStates: [] type: VTEX connectorPageUrl: connector.vtex.com/connectorPageUrl connectorVtexAdminPath: connector.vtex.com/connectorVtexAdminPath connectorApiEndpoint: connector.vtex.com/connectorApiEndpoint channelId: '1234' isGloballyAvailable: false ownerVtexAccount: comercialsaopaulo isActive: false isCertified: true contactInfo: name: Jhon Jones email: comercialsp@comercialsaopaulo.com phone: (77) 7777-7777 defaultMessage: |- Olá, aqui é (...) da (...). Adoraríamos incluir sua loja em nossa vitrine, pois acreditamos que (...). Seguem algumas informações importantes para darmos seguimento à nossa parceria: 1) Nosso marketplace conta as categorias - A - B - C 2) Nossa política de cobrança inclui uma taxa de (...) para cada compra, mais assinatura fixa de (...) por mês. 3) Saiba mais sobre nossa política de devoluções e envio neste link (...). isConnectionActive: false affiliateId: '1234' deprecated: false /api/channel-manager/connector/:connectorId: get: tags: - External Marketplace summary: VTex Retrieve connector description: Retrieve a specific connector registered in VTEX platform. operationId: retrieve-connector parameters: - name: environment in: path description: Environment used as part of URL. required: true style: simple schema: type: string example: https://portal.vtexcommercestable.com.br - name: connectorId in: path description: Connector's ID in Channel Manager, available through the List all connectors, or in the response of the registration. required: true style: simple schema: type: integer example: 46 - name: an in: query description: VTEX's account name owned by the connector/partner. required: true style: form schema: type: string example: apiexemple - name: accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: content-type in: header description: Describes the type of the content being sent. required: true style: simple schema: type: string default: application/json responses: '200': description: OK headers: {} content: application/json: schema: title: Response body description: Expected response body of Retrieve connector type: object required: - id - name - website - logo - description - helpUrl - segment - availableCountries - availableStates - type - connectorPageUrl - connectorVtexAdminPath - connectorApiEndpoint - channelId - isGloballyAvailable - ownerVtexAccount - isActive - isCertified - contactInfo - isConnectionActive - affiliateId properties: id: title: Id description: The connector Id. type: number example: 46 name: title: Connector name description: Connector name to retrieve. type: string example: B2W website: title: Website description: Website connector. type: string example: https://venda.americanasmarketplace.com.br/cadastre-sua-loja/ logo: title: Logo description: '' type: string example: https://s3.amazonaws.com/Marketplace-Integration/Bridge/logos/skyhub.png description: title: Description description: Description about the connector. type: string example: A B2W e as Lojas Americanas fizeram uma fusão, dando origem ao Americanas Marketplace. Através do conector nativo da VTEX, é possível integrar com a B2W e aumentar seus canais de venda. helpUrl: title: helpUrl description: Link to User Documentation on Connector Setup. type: string example: https://help.vtex.com/pt/tracks/configurar-integracao-da-b2w--6w07SJBVqE020KIOOS8ygk segment: title: segment description: Connector segment. type: string example: DEPARTMENT_STORES availableCountries: title: availableCountries description: Countries where the marketplace is available. type: array items: title: country description: '' type: string example: BRA example: - BRA availableStates: title: availableStates description: '' type: array items: {} example: - [] type: title: type description: Connector integration type. type: string example: NATIVE connectorPageUrl: title: connectorPageUrl description: In the `connectorPageUrl` field, the partner fills in a complete URL where the merchant will be redirected to start the integration process. type: string example: '' connectorVtexAdminPath: title: connectorVtexAdminPath description: It's the URL path inside our admin where the merchant can be redirected to manage and view his connection after it's already integrated. type: string example: /admin/marketplace-network/configuration/skyhub/ connectorApiEndpoint: title: connectorApiEndpoint description: The field refers to the base URL of the partner connector's API. type: string example: https://portal.vtexcommercestable.com.br/api/skyhubintegration channelId: title: channelId description: Channel Id that can be queried through the List all channels. type: number example: 7 isGloballyAvailable: title: isGloballyAvailable description: In which version the connector is available. type: boolean example: false ownerVtexAccount: title: ownerVtexAccount description: ' Owner account VTEX.' type: string example: vtex isActive: title: isActive description: Demonstrates the status of integration with the connector. type: boolean example: true isCertified: title: isCertified description: Demonstrates Demonstrates if the connector is certified. type: boolean example: false contactInfo: title: contactInfo description: Seller contact information. type: object required: - name - email - phone - defaultMessage properties: name: title: name description: Name of the person responsible for the marketplace account interested in connecting to the merchant. type: string example: Jhon email: title: email description: Email of the person responsible for the marketplace account interested in connecting to the merchant. type: string example: jhon@marketplace.com phone: title: phone description: Phone of the person responsible for the marketplace account interested in connecting to the merchant. type: string example: (77) 7777-7777 defaultMessage: title: defaultMessage description: Introduction message and information of interest in the partnership with the merchant. type: string example: |- Olá, aqui é (...) da (...). Adoraríamos incluir sua loja em nossa vitrine, pois acreditamos que (...). Seguem algumas informações importantes para darmos seguimento à nossa parceria: 1) Nosso marketplace conta as categorias - A - B - C 2) Nossa política de cobrança inclui uma taxa de (...) para cada compra, mais assinatura fixa de (...) por mês. 3) Saiba mais sobre nossa política de devoluções e envio neste link (...). example: name: Jhon email: jhon@marketplace.com phone: (77) 7777-7777 defaultMessage: |- Olá, aqui é (...) da (...). Adoraríamos incluir sua loja em nossa vitrine, pois acreditamos que (...). Seguem algumas informações importantes para darmos seguimento à nossa parceria: 1) Nosso marketplace conta as categorias - A - B - C 2) Nossa política de cobrança inclui uma taxa de (...) para cada compra, mais assinatura fixa de (...) por mês. 3) Saiba mais sobre nossa política de devoluções e envio neste link (...). isConnectionActive: title: isConnectionActive description: '' type: boolean example: true affiliateId: title: affiliateId description: affiliate Id connector. type: string example: BTW deprecated: false post: tags: - External Marketplace summary: VTex Upsert merchant connection description: 'Receives an event describing a connection update between the connector with the specified ID and the merchant specified in the query string. /n/r This information is used in the list all connectors route: the account name will be used to return the `isConnectionActive` and `affiliateId` fields.' operationId: upsert-merchant-connection parameters: - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: Content-Type in: header description: Describes the type of the content being sent. required: true style: simple schema: type: string default: application/json - name: environment in: path description: Environment used as part of URL. required: true style: simple schema: type: string example: https://portal.vtexcommercestable.com.br - name: connectorId in: path description: Connector's ID in Channel Manager, available through the list all connectors route, or in the response of the registration. required: true style: simple schema: type: integer example: 46 - name: an in: query description: Merchant's account name in VTEX, ex. `apiexemple`. required: true style: form schema: type: string example: apiexemple requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/upsertMerchantConnection' example: isActive: true affiliateId: B2W responses: '200': description: OK headers: {} deprecated: false delete: tags: - External Marketplace summary: VTex Remove connector description: Removes a connector from VTEX platform. This action can only be executed by the account name that owns the connector's registration. operationId: remove-connector parameters: - name: environment in: path description: Environment used as part of URL. required: true style: simple schema: type: string example: https://portal.vtexcommercestable.com.br - name: connectorId in: path description: Connector's ID in Channel Manager, available through the List all connectors route, or in the response of the registration. required: true style: simple schema: type: number example: 46 - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: Content-Type in: header description: Describes the type of the content being sent. required: true style: simple schema: type: string default: application/json - name: an in: query description: Merchant's account name in VTEX, ex. `apiexemple`. required: true style: form schema: type: string example: apiexemple responses: '200': description: OK headers: {} deprecated: false put: tags: - External Marketplace summary: VTex Full update connector description: Fully updates the connector's information. All required fields must be sent in the body of the request./n/nThis action can only be executed by the account name that owns the connector's registration. operationId: full-update-connector parameters: - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: environment in: path description: Environment used as part of URL. required: true style: simple schema: type: string example: https://portal.vtexcommercestable.com.br - name: connectorId in: path description: Connector's ID in Channel Manager, available through the list all connectors route, or in the response of the registration. required: true style: simple schema: type: number example: 46 - name: an in: query description: VTEX's account name owned by the connector or partner, ex. `apiexemple`. required: true style: form schema: type: string example: apiexemple - name: Content-Type in: header description: Describes the type of the content being sent. required: true style: simple schema: type: string default: application/json requestBody: description: Body of the request to execute the Full update connector. content: application/json: schema: $ref: '#/components/schemas/fullUpdateConnector' responses: '200': description: OK headers: {} deprecated: false patch: tags: - External Marketplace summary: VTex Partial update connector description: Partially updates the connector's information. The payload follows the format defined by RFC 6902, where a list of operations is informed, including the path of the field inside the object and its value./n/nThis action can only be executed by the account name that owns the connector's registration. operationId: partial-update-connector parameters: - name: environment in: path description: Environment used as part of URL. required: true style: simple schema: type: string example: https://portal.vtexcommercestable.com.br - name: connectorId in: path description: Connector's ID in Channel Manager, available through the list all connectors route, or in the response of the registration. required: true style: simple schema: type: number example: 46 - name: an in: query description: VTEX's account name owned by the connector/partner, ex. `apiexemple`. required: true style: form schema: type: string example: apiexemple - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: Content-type in: header description: Required header to indicate the request is a PATCH. required: true style: simple schema: type: string default: application/json-patch+json requestBody: description: Body of the request to execute the Partial update connector call. content: application/json: schema: $ref: '#/components/schemas/partialUpdateConnector' responses: '200': description: OK headers: {} deprecated: false security: - appKey: [] appToken: [] components: schemas: VtexMapperRegistration: required: - displayName - categoryTreeEndPoint - mappingEndPoint - properties type: object properties: displayName: type: string description: Marketplace Name, that will be displayed in VTEX Mapper. example: Marketplace A categoryTreeEndPoint: type: string description: Endpoint that returns categories and attributes according to VTEX Mapper specifications. example: http://api.vtexinternal.com.br/api/{{marketplaceName}}/mapper/categories mappingEndPoint: type: string description: Secure endpoint that will receive the category mapping sent by VTEX Mapper. example: http://api.vtexinternal.com.br/api/{{marketplaceName}}/mapper/mapping properties: required: - allowsRemap type: object description: Refers to the `allowsRemap` property. items: type: object properties: allowsRemap: type: boolean description: Allows rempaping categories in case the marketplace or seller tree is altered. If marked as `true`, all trees will be remapped. example: false CategoryTreeProcessingNotificationEndpoint: description: The `CategoryTreeProcessingNotificationEndpoint` is optional, and should be an endpoint from the external marketplace, that will be notified after the marketplace's category tree is successfully processed or not. type: string example: https://CategoryTreeProcessingNotificationEndpoint.com/api sendCategoryMappingToVtexMapper: required: - categories - id - name type: object properties: categories: required: - id - name - children type: array title: '' description: Array with Marketplace parent categories and their information. default: [] items: type: object title: '' properties: id: type: string title: id description: ID of the parent category in the marketplace. default: '1' name: type: string title: name description: Name of the parent category in the marketplace. default: Appliances children: type: array title: chidren description: Array with children categories in the marketplace, and their information. default: [] items: type: object required: - id - name - children - specifications properties: id: type: string title: id description: ID of the child category in the marketplace. default: 1a name: type: string title: name description: Name of the child category in the marketplace. default: Kitchen children: type: array title: children description: Grandchildren categories in the marketplace. Send as array of `ID`, `name` and `specifications`. default: [] items: {} nullable: true specifications: type: array title: specifications description: Specifications for the Product or SKU default: - attributeName: Color required: true attributeValues: - valueName: Red items: type: object description: Specifications of children categories. example: attributeName: Color required: true attributeValues: - valueName: Red required: - attributeName - required - attributeValues properties: attributeName: type: string title: attributeName description: Name of the attribute sent as a specification. default: Color required: type: boolean title: required description: If the specification is required, mark this flag as `true`. If not, mark it as `false`. default: false attributeValues: type: array title: attributeValues description: Values of the atttribute specified. default: - valueName: Red items: type: object title: valueName description: Array of the multiple `valueNames` for the attribute specificied. default: valueName: Red required: - valueName properties: valueName: type: string title: valueName description: Name of the value default: Red upsertMerchantConnection: title: Upsert merchant connection required: - isActive - affiliateId type: object properties: isActive: type: boolean default: false affiliateId: type: string default: '' fullUpdateConnector: title: '' required: - name - website - logo - description - segment - availableCountries - connectorVtexAdminPath - connectorApiEndpoint type: object properties: name: type: string default: '' description: Connector's name. website: type: string default: '' description: Connector's website. logo: type: string default: '' description: Connector's logo. description: type: string default: '' description: Marketplace presentation description. segment: type: string default: '' description: Marketplace segment. availableCountries: type: array default: [] description: Countries where integration is available. items: type: string connectorVtexAdminPath: type: string default: '' title: Link to Admin VTEX page where the merchant can configure integration with connector. connectorApiEndpoint: type: string default: '' title: Connector's API Base URL example: name: Mercado Livre Classic website: mercadolivre.com.br logo: https://g.foolcdn.com/art/companylogos/square/meli.png description: MercadoLibre operates online commerce platforms in Latin America. It operates Mercado Libre Marketplace, an automated online commerce platform that enables businesses, merchants, and individuals to list merchandise and conduct sales and purchases online. segment: OTHERS availableCountries: - BRA - ARG connectorVtexAdminPath: /bridge/#/settings?openConfig=mercadolivre connectorApiEndpoint: portal.vtexcommercestable.com/api/meliintegration/notifications partialUpdateConnector: title: Partial update connector required: - path - op - value type: object properties: path: type: string default: '' description: What part of the configuration do you want to change. op: type: string default: '' description: Type of operation to be performed. value: type: string default: '' description: New value which will appear in the changed field. example: path: /segment op: replace value: DEPARTMENT_STORES securitySchemes: appKey: type: apiKey in: header name: X-VTEX-API-AppKey appToken: type: apiKey in: header name: X-VTEX-API-AppToken tags: - name: External Marketplace