Integration Guides
External Marketplace Integration app GraphQL API
GraphQL API reference for the External Marketplace integration app.
This document outlines the GraphQL API for managing external marketplace integrations within the VTEX ecosystem, provided via the mkp-app-template app template. The API enables querying and modifying integration settings, including sales channel configurations, affiliate mappings, and account details.
Schema overview
Query
| Field | Argument | Type | Description |
|---|---|---|---|
| getConfiguration | Configuration | Retrieves the current marketplace integration configuration, including account settings, affiliate details, and sales channel information. | |
| getSalesChannel | SalesChannel | Retrieves detailed properties of a specific sales channel using its unique ID. | |
| salesChannelId | String | Sales channel ID. | |
Mutation
| Field | Argument | Type | Description |
|---|---|---|---|
| saveConfiguration | String | Updates the integration configuration with the provided settings. Returns a success message or error if the operation fails. | |
| config | ConfigurationInput | Properties of the configuration to be saved. | |
| createSalesChannel | String | Creates or updates a sales channel with the provided information. Returns a success message or error if the operation fails. | |
| salesChannelData | SalesChannelInput | Sales channel properties to be created or modified. | |
Schema description
Arguments must be provided by the user. Required fields are marked with an exclamation mark (
!).
Configuration
| Field | Type | Description |
|---|---|---|
| accountName | String | Account name where the integration is installed. |
| active | Boolean | Indicates whether the integration is active. If true, the integration is active. If false, the integration is inactive. |
| affiliateId | String | ID (3 consonants) that represents the connection with the external marketplace. The ID needs to be unique in the VTEX seller account. Example: LVL. |
| salesChannel | String | Sales channel ID, which defines the catalog that will be sent to the marketplace. Example: 1. |
String | Email that will receive VTEX notifications related to the affiliate. | |
| allowFranchiseAccounts | Boolean | Indicates whether the integration allows franchise accounts. If true, the integration allows them. If false, the integration doesn't allow them. |
Query 🔼
SalesChannel
| Field | Type | Description |
|---|---|---|
| Id | ID! | Sales channel ID. Example: 1. |
| Name | String | Sales channel name. Example: "Marketplace channel". |
| CountryCode | String | Sales channel country code in ISO 3166-1 alpha-2 format for the external marketplace. Example: "US". |
| CultureInfo | String | Sales channel culture information for the external marketplace in IETF BCP 47 format and combining a language code in ISO-639 format and a region code in ISO 3166-1 alpha-2 format. Example: "en-US". |
| TimeZone | String | Sales channel time zone name for the external marketplace. Example: "Pacific Standard Time". |
| CurrencyCode | String | Sales channel currency code in ISO 4217 format for the external marketplace. Example: "USD". |
Query 🔼
ConfigurationInput
| Field | Type | Description |
|---|---|---|
| accountName | String | Name of the account where the integration is installed. |
| active | Boolean | Property that defines if the integration is active. If true, the integration is active. If false, the integration is inactive. |
| affiliateId | String | ID (3 consonants) that represents the connection with the external marketplace. The ID needs to be unique in the VTEX seller account. Example: LVL. |
| salesChannel | String | Sales channel ID, which defines the catalog that will be sent to the marketplace. Example: 1. |
String | Email that will receive VTEX notifications related to the affiliate. | |
| allowFranchiseAccounts | Boolean | Property that defines if the integration allows franchise accounts. If true, the integration allows them. If false, the integration doesn't allow them. |
Mutation 🔼
SalesChannelInput
| Field | Type | Description |
|---|---|---|
| Id | ID! | Sales channel ID. Example: 1. |
| Name | String | Sales channel name. Example: "Marketplace channel". |
| CountryCode | String | Sales channel country code in ISO 3166-1 alpha-2 format for the external marketplace. Example: "US". |
| CultureInfo | String | Sales channel culture information for the external marketplace in IETF BCP 47 format and combining a language code in ISO-639 format and a region code in ISO 3166-1 alpha-2 format. Example: "en-US". |
| TimeZone | String | Sales channel time zone name for the external marketplace. Example: "Pacific Standard Time". |
| CurrencyCode | String | Sales channel currency code in ISO 4217 format for the external marketplace. Example: "USD". |