Skip to main content

VTEX

VTEX e-commerce platform — catalog, orders, pricing, logistics, promotions, checkout, payments, search and more.

VTEX Logo

Authentication​

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use​

Using the Smart Chat​

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor​

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions​

This connector provides 1173 actions:

ActionPurposeParameters
ads/servers_product_bulk_productsNo description availableNo parameters
ads/post_product_bulk_productsUpdates the basic product data in the VTEX Ads catalog. ⚠️ For each batch insert/update, a maximum of 500 objects per request and 3 simultaneous requests are allowed. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/docs/tutorials/license-manager-resources.Content-Type (string) required
Accept (string) required
data (array) required
ads/servers_product_bulk_inventoriesNo description availableNo parameters
ads/post_product_bulk_inventoriesUpdate inventory information, which defines the price, promotional price, and product availability. ⚠️ For each batch insert/update, a maximum of 500 objects per request and three simultaneous requests are allowed. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/docs/tutorials/license-manager-resources.Content-Type (string) required
Accept (string) required
data (array) required
ads/servers_v1_beacon_impression_by_ad_idNo description availablead_id (string)
ads/post_v1_beacon_impression_by_ad_idTrack when an ad is rendered or visible to a user. The event URL must not be constructed manually — always use the URL provided from POST Get adshttps://developers.vtex.com/docs/api-reference/vtex-ads-api post-/v1/rma/-publisher_id-. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/docs/tutorials/license-manager-resources.ad_id (string)
Content-Type (string) required
Accept (string) required
pos (string)
data: {
. user_id (string)
. session_id (string)
} (object) required
ads/servers_v1_beacon_click_by_ad_idNo description availablead_id (string)
ads/post_v1_beacon_click_by_ad_idTrack when a user clicks on an ad. The event URL must not be constructed manually — always use the URL provided from POST Get adshttps://developers.vtex.com/docs/api-reference/vtex-ads-api post-/v1/rma/-publisher_id-. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/docs/tutorials/license-manager-resources.ad_id (string)
Content-Type (string) required
Accept (string) required
pos (string)
data: {
. user_id (string)
. session_id (string)
} (object) required
ads/servers_v1_beacon_view_by_ad_idNo description availablead_id (string)
ads/post_v1_beacon_view_by_ad_idTrack views for banner ads. The event URL must not be constructed manually — always use the URL provided from POST Get adshttps://developers.vtex.com/docs/api-reference/vtex-ads-api post-/v1/rma/-publisher_id-. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/docs/tutorials/license-manager-resources.ad_id (string)
Content-Type (string) required
Accept (string) required
pos (string)
data: {
. user_id (string)
. session_id (string)
} (object) required
ads/servers_v1_beacon_conversionNo description availableNo parameters
ads/post_v1_beacon_conversionTrack when an ad leads to a purchase. This endpoint is used to notify one or more orders sending them in a batch. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/docs/tutorials/license-manager-resources.Content-Type (string) required
Accept (string) required
data: {
. channel (string)
. brand (string)
. publisher_id (string)
. user_id (string)
. session_id (string)
. order_id (string)
. email_hashed (string)
. items (array)
. created_at (string)
. is_company (boolean)
. gender (string)
. uf (string)
. city (string)
. phone_hashed (string)
. social_id_hashed (string)
. first_name_hashed (string)
. last_name_hashed (string)
} (object) required
ads/servers_v1_rma_by_publisher_idNo description availablepublisher_id (string)
ads/post_v1_rma_by_publisher_idRetrieve Product and Banner ad formats based on context and placements. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/docs/tutorials/license-manager-resources. Request best practices - HTTP persistence: Prefer persistent connections Connection: keep-alive. - Timeout: Apply a 500-600 ms timeout to the ad query. Context-specific fields The context value determines which additional fields are required in the request body. The epublisher_id (string)
Content-Type (string) required
Accept (string) required
data: {
. session_id (string)
. user_id (string)
. store_id (string)
. context (string)
. term (string)
. category_name (string)
. product_sku (string)
. brand_name (string)
. placements (object)
. product_attributes (object)
. channel (string)
. device_id (string)
. store_name (string)
. brand (string)
. userAgent (string)
. tags (array)
. skus (array)
. dedup_campaign_ads (boolean)
. dedup_ads (boolean)
. segmentation (array)
} (object) required
ads/servers_report_v2_advertisersNo description availableNo parameters
ads/get_report_v2_advertisersRetrieves information from all advertisers associated with a publisher account. The data is returned in JSON format by default, but can be exported as an XLSX file by setting download=true. ℹ️ Only available in the publisher view publisher account. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/docs/tutorials/license-manager-resources.Content-Type (string) required
Accept (string) required
start_date (string) required
end_date (string) required
account_info (boolean)
page (integer)
quantity (integer)
count (boolean)
download (boolean)
ads/servers_report_v2_publishersNo description availableNo parameters
ads/get_report_v2_publishersRetrieves information about the publishers associated with an advertiser account. The data is returned in JSON format by default, but can be exported as an XLSX file by setting download=true. ℹ️ Only available in the advertiser view advertiser account. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/docs/tutorials/license-manager-resources.Content-Type (string) required
Accept (string) required
start_date (string) required
end_date (string) required
publisher_name (string)
account_info (boolean)
page (integer)
quantity (integer)
count (boolean)
order_by (string)
order_direction (string)
download (boolean)
ads/servers_report_network_publishersNo description availableNo parameters
ads/get_report_network_publishersRetrieves information about publishers associated with a Network Publisher account. The data is returned in JSON format by default, but can be exported as an XLSX file by setting download=true. ℹ️ Only publishers operating in the Network format are allowed to access this report. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/docs/tutorials/license-manager-resources.Content-Type (string) required
Accept (string) required
start_date (string) required
end_date (string) required
publisher_name (string)
account_info (boolean)
page (integer)
quantity (integer)
count (boolean)
order_by (string)
order_direction (string)
download (boolean)
ads/servers_campaign_v2No description availableNo parameters
ads/get_campaign_v2Fetches all available campaigns, applying filters as needed. The data is returned in JSON format by default, but can be exported as an XLSX file by setting download=true. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/docs/tutorials/license-manager-resources.Content-Type (string) required
Accept (string) required
start_date (string) required
end_date (string) required
status (string)
advertiser_id (string)
ad_type (string)
name (string)
account_info (boolean)
page (integer)
quantity (integer)
count (boolean)
order_by (string)
order_direction (string)
download (boolean)
ads/servers_campaign_by_campaign_idNo description availablecampaign_id (string)
ads/get_campaign_by_campaign_idRetrieves detailed information about a campaign, such as the products associated with the campaign, status history, ads, and metrics. The data is returned only in JSON format. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/docs/tutorials/license-manager-resources.campaign_id (string)
Content-Type (string) required
Accept (string) required
start_date (string) required
end_date (string) required
ads/servers_report_advertisers_campaigns_detailedNo description availableNo parameters
ads/get_report_advertisers_campaigns_detailedExports a mixed campaign report for advertiser accounts, including both regular campaigns and subpublisher information for network campaigns. The data is returned in JSON format by default, but can be exported as an XLSX file by setting download=true. ℹ️ This route is intended for advertiser accounts. For non white-label accounts, only non-private publisher rows are returned. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/docs/tutorials/liceContent-Type (string) required
Accept (string) required
start_date (string) required
end_date (string) required
campaign_id (string)
campaign_status (string)
publisher_id (string)
publisher_name (string)
ad_type (string)
ad_status (string)
seller_id (string)
tag_id (string)
targeting_type (string)
sub_publisher_id (string)
sub_publisher_name (string)
page (integer)
quantity (integer)
count (boolean)
order_by (string)
order_direction (string)
download (boolean)
ads/servers_report_advertisers_ads_detailedNo description availableNo parameters
ads/get_report_advertisers_ads_detailedExports a detailed ad report for advertiser accounts, including subpublisher breakdown for network campaigns. The data is returned in JSON format by default, but can be exported as an XLSX file by setting download=true. ℹ️ This route is intended for advertiser accounts. Non-network campaigns return one row per ad, while network campaigns return one row per ad + subpublisher. For non white-label accounts, only non-private publisher rows are returned. Permissions This endpoint does notContent-Type (string) required
Accept (string) required
start_date (string) required
end_date (string) required
campaign_name (string)
campaign_id (string)
publisher_id (string)
advertiser_id (string)
product_sku (string)
ad_status (string)
ad_type (string)
targeting_type (string)
tag_id (string)
sub_publisher_id (string)
sub_publisher_name (string)
show_inactive (boolean)
hide_pending_rejected (boolean)
page (integer)
quantity (integer)
count (boolean)
order_by (string)
order_direction (string)
download (boolean)
ads/servers_ad_results_v2No description availableNo parameters
ads/get_ad_results_v2Fetches all available ads, applying filters as needed. The data is returned in JSON format by default, but can be exported as an XLSX file by setting download=true. ℹ️ Paused ads are excluded from the default response. To include paused ads, set show_inactive=true. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/docs/tutorials/license-manager-resources.Content-Type (string) required
Accept (string) required
start_date (string) required
end_date (string) required
campaign_name (string)
campaign_id (string)
advertiser_id (string)
product_sku (string)
ad_status (string)
ad_type (string)
targeting_type (string)
show_inactive (boolean)
account_info (boolean)
page (integer)
quantity (integer)
count (boolean)
order_by (string)
order_direction (string)
download (boolean)
ads/servers_webhook_marketplace_transfers_by_publisher_idNo description availablepublisher_id (string)
ads/post_webhook_marketplace_transfers_by_publisher_idNotifies VTEX Ads about the final status of a credit transfer that was previously requested by VTEX Ads to the marketplace's POST /checking_account/transfer endpoint. The marketplace must call this webhook with the resolved status of each transfer transaction. ⚠️ In case of a webhook call failure, the marketplace must retry until a 204 No Content response is received. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/docs/tutorials/license-manapublisher_id (string)
Content-Type (string) required
Accept (string) required
data: {
. transaction_id (string)
. status (string)
. message (string)
} (object) required
ads/servers_audience_upload_urlNo description availableNo parameters
ads/post_audience_upload_urlReturns a short-lived pre-signed Amazon S3 POST that lets a publisher upload an audience file without long-lived credentials. The response carries the destination url and the signed fields that must accompany the upload. The backend builds the object key from the authenticated publisher, so a publisher cannot write to another publisher's path. The pre-signed POST is valid for expires_in seconds 900 by default and Amazon S3 rejects files larger than max_bytes 2 GiB by default. ℹ️ The file uAccept (string) required
ads/servers_sso_marketplaceNo description availableNo parameters
ads/post_sso_marketplaceGenerates a redirect URL that allows a seller user to access the VTEX Ads platform without needing to log in again. Use this endpoint to enable a unified login experience for marketplace sellers. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/docs/tutorials/license-manager-resources.Content-Type (string) required
Accept (string) required
data: {
. sso_token (string)
. email (string)
. user_id (string)
. name (string)
. marketplace_name (string)
} (object) required
ads/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
antifraud_provider/post_pre_analysisReceives a new transaction anti-fraud data for synchronous pre-analysis. This step is performed before payments authorization. ⚠️ This endpoint can only be used if your anti-fraud provider already has the pre-analysis function configured within VTEX. To check if it is already configured, in the VTEX Admin, go to Store Settings Payment Providers, click the name of your anti-fraud provider, and verify if the Enable Risk Pre-Analysis field is available to be selected. If the Enable Risk Pre-AnX-PROVIDER-API-AppKey (string) required
X-PROVIDER-API-AppToken (string) required
Content-Type (string) required
Accept (string) required
data: {
. id (string)
. reference (string)
. value (integer)
. ip (string)
. store (string)
. deviceFingerprint (string)
. miniCart
. payments
. hook (string)
. transactionStartDate (string)
. merchantSettings (array)
} (object) required
antifraud_provider/post_transactionsReceives a new transaction anti-fraud data. This step is performed only if all payments are authorized. VTEX expects that your anti-fraud provider process this request and retrieves the process result. After that, the VTEX order flow will check the response status to cancel or approve the transaction. Only data from the main account is sent from VTEX to the anti-fraud system. Information related to subaccounts is not included in the request. Permissions This endpoint does not reqX-PROVIDER-API-AppKey (string) required
X-PROVIDER-API-AppToken (string) required
Content-Type (string) required
Accept (string) required
data: {
. id (string)
. reference (string)
. value (integer)
. ip (string)
. store (string)
. deviceFingerprint (string)
. miniCart
. payments
. hook (string)
. transactionStartDate (string)
. merchantSettings (array)
} (object) required
antifraud_provider/put_transactions_by_transaction_idReceives a new transaction anti-fraud data. This step is performed only if all payments are authorized. VTEX expects that your anti-fraud provider process this request and retrieves the process result. After that, the VTEX order flow will check the response status to cancel or approve the transaction. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.transactions.Id (string)
transactionId (string)
X-PROVIDER-API-AppKey (string) required
X-PROVIDER-API-AppToken (string) required
Content-Type (string) required
Accept (string) required
data: {
. id (string)
. reference (string)
. value (integer)
. ip (string)
. store (string)
. deviceFingerprint (string)
. miniCart
. payments (array)
. hook (string)
} (object) required
antifraud_provider/get_manifestReturns the custom fields of the anti-fraud provider manifest. Permissions This endpoint does not require authenticationhttps://developers.vtex.com/docs/guides/authentication or permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
antifraud_provider/get_transactions_by_transactions_idRetrieves the anti-fraud analysis status. This request is performed every two hours up to 5 days. After 5 days in undefined status, the order will expire and be cancelled. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.transactions.Id (string)
transactions.id (string)
X-PROVIDER-API-AppKey (string) required
X-PROVIDER-API-AppToken (string) required
Content-Type (string) required
Accept (string) required
antifraud_provider/delete_transactions_by_transactions_idNotifies whether the order has been canceled by the store or the buyer before completing the anti-fraud analysis status. This endpoint is not mandatory for the antifraud flow to work. Check this developer guidehttps://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works for more details. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.transactions.Id (string)
X-PROVIDER-API-AppKey (string) required
X-PROVIDER-API-AppToken (string) required
Content-Type (string) required
Accept (string) required
antifraud_provider/post_authorization_tokenThis endpoint is used to retrieve a payment provider token. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.X-PROVIDER-API-AppKey (string) required
X-PROVIDER-API-AppToken (string) required
Content-Type (string) required
Accept (string) required
data: {
. applicationId (string)
. returnUrl (string)
} (object) required
antifraud_provider/get_redirectThrough this endpoint, VTEX will redirect the store administrator to the Payment provider website using the token retrieved in the previous requesthttps://developers.vtex.com/docs/api-reference/antifraud-provider-protocol post-/authorization/token. At this point in the flow, the provider shows the login site to the store admin and authorizes VTEX to use its integration as a valid Payment Provider Processor. After that, your server generates an authorizationCode. Permissions This endptoken (string) required
applicationId (string) required
X-PROVIDER-API-AppKey (string) required
X-PROVIDER-API-AppToken (string) required
Content-Type (string) required
Accept (string) required
antifraud_provider/get_authorization_codeThrough this endpoint, the provider will redirect the store administrator to the VTEX website using the returnUrl passed from VTEX to create token. The returnUrl must be filled with your query string authorizationCode. Example: If you receive the following URL: https://store.vtex.com/return?authorizationCode= and otherparams... and your authorizationCode is pro2018. Then, you redirect the store administrator to: https://store.vtex.com/return?authorizationCode=pro2018 and otherparaproviderAuthorizationCode (string) required
X-PROVIDER-API-AppKey (string) required
X-PROVIDER-API-AppToken (string) required
antifraud_provider/get_authorization_credentialsRetrieves merchant credentials. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.authorizationCode (string) required
applicationId (string) required
X-PROVIDER-API-AppKey (string) required
X-PROVIDER-API-AppToken (string) required
antifraud_provider/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
audience/post_api_audience_manager_pvt_audienceFetch the audience ID based on the provided shopper email. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
an (string)
data: {
. email (string)
} (object) required
audience/get_api_price_table_mapper_pvt_mapping_by_audience_idFetches the price table mapping for a specific audience. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.audienceId (string)
Content-Type (string) required
Accept (string) required
audience/put_api_price_table_mapper_pvt_mapping_by_audience_idSets one or more price table mappings for the specified audience. Each price table ID in the array defines a distinct price table that applies to the audience. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.audienceId (string)
Content-Type (string) required
Accept (string) required
data (array) required
audience/delete_api_price_table_mapper_pvt_mapping_by_audience_idRemoves the price table mapping for the provided audience. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.audienceId (string)
Content-Type (string) required
Accept (string) required
audience/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
b2b_addresses/post_api_dataentities_ad_documentsCreates a new B2B address document in the AD data entity. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise tContent-Type (string) required
Accept (string) required
data: {
. addressName (string)
. addressLabel (string)
. addressType (string)
. receiverName (string)
. city (string)
. state (string)
. country (string)
. postalCode (string)
. street (string)
. number (string)
. neighborhood (string)
. complement (string)
. reference (string)
. geoCoordinates (array)
. userId (string)
} (object) required
b2b_addresses/get_api_dataentities_ad_searchRetrieves B2B addresses from the AD data entity, with support for field selection, filtering, sorting, and pagination. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. ℹ️ Learn more about Pagination in the Master Data APIhttps://developers.vtex.com/docs/guides/pagination-in-the-master-data-api and Querying documents in Master Data v1https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1. QueryAccept (string) required
REST-Range (string) required
_fields (string)
_where (string)
_sort (string)
b2b_addresses/get_api_dataentities_ad_documents_by_address_idRetrieves information of a specific B2B address by its unique identifier. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this requaddressId (string)
Accept (string) required
_fields (string)
b2b_addresses/patch_api_dataentities_ad_documents_by_address_idPartially updates an existing B2B address document in the AD data entity. ⚠️ When updating addresses you must send each field according to the specifications provided. Otherwise, the Checkout module will not be able to autofill data during the shopping flow, which can block the purchase. Learn more about SmartCheckout - Customer information automatic fill-inhttps://help.vtex.com/en/tutorial/smartcheckout-preenchimento-automatico-de-dados-do-cliente--2Nuu3xAFzdhIzJIldAdtan. ⚠️ This featureaddressId (string)
Content-Type (string) required
Accept (string) required
data: {
. addressName (string)
. addressLabel (string)
. addressType (string)
. receiverName (string)
. city (string)
. state (string)
. country (string)
. postalCode (string)
. street (string)
. number (string)
. neighborhood (string)
. complement (string)
. reference (string)
. geoCoordinates (array)
. userId (string)
} (object) required
b2b_addresses/delete_api_dataentities_ad_documents_by_address_idDeletes a specific B2B address document from the AD data entity. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. OtheaddressId (string)
Accept (string) required
b2b_addresses/post_api_dataentities_contact_information_documentsCreates a new recipient document in the contact_information data entity. A recipient represents a person who can receive orders at one or more B2B addresses. Use the addressIds field to associate the recipient with existing B2B addresses from the AD data entity. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys muContent-Type (string) required
Accept (string) required
data: {
. email (string)
. firstName (string)
. lastName (string)
. profileId (string)
. phone (string)
. phoneExtension (string)
. document (string)
. documentType (string)
. addressIds (array)
} (object) required
b2b_addresses/get_api_dataentities_contact_information_searchSearches for recipients in the contact_information data entity based on the query parameters. Recipients returned by this endpoint can be linked to one or more B2B addresses through the addressIds field. ⚠️ The _schema query parameter is required and must be set to v1. ℹ️ It is also possible to use pagination and sort as described in the Master Data v2 Search APIhttps://developers.vtex.com/docs/api-reference/master-data-api-v2 get-/api/dataentities/-dataEntityName-/search documentation.Accept (string) required
_where (string) required
_fields (string)
_schema (string) required
b2b_addresses/get_api_dataentities_contact_information_documents_by_recipient_idRetrieves a recipient by ID from the contact_information data entity. The returned recipient may be associated with one or more B2B addresses through the addressIds field. ℹ️ Assign the _fields parameter in the query string to retrieve the desired fields. If you want to return all the fields use _fields=_all. ⚠️ The _schema query parameter is required and must be set to v1. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounrecipientId (string)
Accept (string) required
_fields (string)
_schema (string) required
b2b_addresses/patch_api_dataentities_contact_information_documents_by_recipient_idPartially updates a recipient document in the contact_information data entity. Use the addressIds field to change the B2B addresses associated with the recipient. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/lrecipientId (string)
Content-Type (string) required
Accept (string) required
data: {
. email (string)
. firstName (string)
. lastName (string)
. profileId (string)
. phone (string)
. phoneExtension (string)
. document (string)
. documentType (string)
. addressIds (array)
} (object) required
b2b_addresses/delete_api_dataentities_contact_information_documents_by_recipient_idDeletes a recipient document from the contact_information data entity. This operation does not delete the B2B addresses associated with the recipient through the addressIds field. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.recipientId (string)
Accept (string) required
b2b_addresses/post_api_dataentities_custom_field_values_documentsCreates a location value associated with a B2B address. A location is a custom checkout fieldhttps://developers.vtex.com/docs/guides/custom-fields-integration value linked to a specific B2B address through the auxId field the B2B address ID. This endpoint assumes the underlying location setting is already configured, which is the native behavior. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any userContent-Type (string) required
Accept (string) required
data: {
. contractId (string)
. customFieldId (string)
. auxId (string)
. value (string)
. description (string)
} (object) required
b2b_addresses/get_api_dataentities_custom_field_values_documents_by_location_idRetrieves a specific location by its ID. The auxId field identifies the B2B address associated with this location. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3locationId (string)
Accept (string) required
_fields (string) required
b2b_addresses/patch_api_dataentities_custom_field_values_documents_by_location_idUpdates a specific location. The auxId field must match the B2B address ID to which the location belongs. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be ablocationId (string)
Content-Type (string) required
Accept (string) required
data: {
. contractId (string)
. customFieldId (string)
. auxId (string)
. value (string)
. description (string)
} (object) required
b2b_addresses/delete_api_dataentities_custom_field_values_documents_by_location_idDeletes a specific location. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status codlocationId (string)
Accept (string) required
_fields (string) required
b2b_addresses/get_api_dataentities_custom_field_values_searchRetrieves locations filtered by contract ID, location setting ID, and optionally by specific value. When searching locations associated with a particular B2B address, filter by auxId=addressId. Results can be sorted by value. You can use the _where query parameter to filter results: - To get all locations for a contract and setting: _where=contractId=contractId AND customFieldId='customFieldId' - To get locations for a specific B2B address: _where=contractId=contractId AND customFieldId='cuAccept (string) required
_schema (string) required
_fields (string) required
_where (string) required
_sort (string)
b2b_addresses/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
b2b_buyer_data/get_api_dataentities_shopper_schemas_v1This endpoint retrieves a buyer entity schemahttps://developers.vtex.com/docs/guides/master-data-schema-lifecycle with buyer personal data. ℹ️ The buyer schema supports additionalProperties: true, allowing clients to send and persist additional properties beyond the defined schema properties e.g., phone2, marketingOptIn, or any business-specific fields. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. PermissionsContent-Type (string) required
Accept (string) required
b2b_buyer_data/post_api_dataentities_shopper_documentsThis endpoint creates a buyer entity document. ℹ️ The buyer schema supports additional properties. Clients can include extra properties e.g., phone2, marketingOptIn in the request body, and they will be persisted alongside the standard fields. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least_schema (string) required
Content-Type (string) required
Accept (string) required
data: {
. userId (string)
. email (string)
. firstName (string)
. lastName (string)
. document (string)
. documentType (string)
. phone (string)
} (object) required
b2b_buyer_data/get_api_dataentities_shopper_documents_by_buyer_idThis endpoint retrieves a buyer entity document by User ID. ℹ️ The response may include additional properties beyond the standard schema if they were previously stored e.g., phone2, marketingOptIn. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourcbuyerId (string)
Content-Type (string) required
Accept (string) required
b2b_buyer_data/patch_api_dataentities_shopper_documents_by_buyer_idThis request allows you to partially update a buyer document. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. ℹ️ You can use this request to update documents for any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update. Permissions Any user or API keyhttps:/buyerId (string)
Accept (string) required
data: {
. userId (string)
. email (string)
. firstName (string)
. lastName (string)
. document (string)
. documentType (string)
. phone (string)
} (object) required
b2b_buyer_data/delete_api_dataentities_shopper_documents_by_buyer_idDeletes a buyer document. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 4buyerId (string)
Content-Type (string) required
Accept (string) required
b2b_buyer_data/get_api_dataentities_shopper_searchThis endpoint searches a buyer entity document by User ID. ℹ️ The response may include additional properties beyond the standard schema if they were previously stored e.g., phone2, marketingOptIn. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run thi_where (string)
_schema (string) required
Content-Type (string) required
Accept (string) required
b2b_buyer_data/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
b2b_contracts/post_api_dataentities_cl_documentsCreates a new contract with an ID automatically generated by VTEX, stored in the CL data entity. The request body is a JSON object where the key is the name of the field. ⚠️ When creating contracts you must send each field according to the specifications provided. Otherwise, the Checkout module will not be able to autofill data during the shopping flow, which can block the purchase. Learn more about SmartCheckout - Customer information automatic fill-inhttps://help.vtex.com/en/tutorial/smartContent-Type (string) required
Accept (string) required
data: {
. email (string)
. firstName (string)
. lastName (string)
. document (string)
. documentType (string)
. corporateDocument (string)
. homePhone (string)
. cellPhone (string)
. corporateName (string)
. tradeName (string)
. isCorporate (boolean)
. stateRegistration (string)
. isFreeStateRegistration (boolean)
. priceTables (string)
. restrictions (object)
} (object) required
b2b_contracts/get_api_dataentities_cl_documents_by_contract_idThis endpoint retrieves information related to a given contract, by its unique identifier. Use the _fields=_all query parameter to return all fields. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-contractId (string)
Content-Type (string) required
Accept (string) required
_fields (string)
b2b_contracts/patch_api_dataentities_cl_documents_by_contract_idUpdates an existing contract by its unique identifier. When updating restrictions, send the complete object for the fields you are changing. ⚠️ When updating contracts you must send each field according to the specifications provided. Otherwise, the Checkout module will not be able to autofill data during the shopping flow, which can block the purchase. Learn more about SmartCheckout - Customer information automatic fill-inhttps://help.vtex.com/en/tutorial/smartcheckout-preenchimento-automatcontractId (string)
Content-Type (string) required
Accept (string) required
data: {
. email (string)
. firstName (string)
. lastName (string)
. document (string)
. documentType (string)
. corporateDocument (string)
. homePhone (string)
. cellPhone (string)
. corporateName (string)
. tradeName (string)
. isCorporate (boolean)
. stateRegistration (string)
. isFreeStateRegistration (boolean)
. priceTables (string)
. restrictions (object)
} (object) required
b2b_contracts/delete_api_dataentities_cl_documents_by_contract_idThis endpoint allows you to delete a specific contract from the data entity CL. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run thiscontractId (string)
Content-Type (string) required
Accept (string) required
b2b_contracts/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
b2b_password_migration_protocol/post_registerRegisters VTEX as a client in your middleware and generates the shared credentials used for HMAC request signing. VTEX calls this endpoint before sending any authentication requests. For more information, see the B2B password migration guidehttps://developers.vtex.com/docs/guides/b2b-password-migration. Your middleware must: 1. Generate a unique ClientId for the store. 2. Generate a high-entropy Secret recommended: 32+ random bytes / 256-bit, encoded as Base64. 3. Store the mapping betwAccept (string) required
data: {
. Store (string)
} (object) required
b2b_password_migration_protocol/post_authenticationValidates a user's legacy credentials against your external authentication system. This endpoint is called by VTEX when a user with the isLegacyPassword flag attempts to log in for the first time. For more information, see the B2B password migration guidehttps://developers.vtex.com/docs/guides/b2b-password-migration. ⚠️ The request to your middleware will always be made from one of the VTEX IPs listed at http://ips.vtex.comhttp://ips.vtex.com. Although VTEX cannot enforce this, we stronglyAccept (string) required
X-VTEX-Client-Id (string) required
X-VTEX-Timestamp (string) required
X-VTEX-Nonce (string) required
X-VTEX-Content-SHA256 (string) required
Authorization (string) required
data: {
. username (string)
. password (string)
} (object) required
b2b_password_migration_protocol/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
budgets/get_api_budgets_by_context_type_by_context_id_by_budget_id_statementsRetrieves the list of transactions statement for a specific budget within the VTEX Budgets API. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfullcontextType (string)
contextId (string)
budgetId (string)
Accept (string) required
page (integer)
pageSize (integer)
budgets/get_api_budgets_by_context_type_by_context_id_by_budget_id_allocations_by_allocation_id_statementsRetrieves the list of transactions statement for a specific allocation within a VTEX budget. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully rcontextType (string)
contextId (string)
budgetId (string)
allocationId (string)
Accept (string) required
page (integer)
pageSize (integer)
budgets/post_api_budgets_by_context_type_by_context_id_by_budget_id_allocations_by_allocation_id_transactionsCreates a new transaction which subtracts funds from the specified budget allocation. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run thiscontextType (string)
contextId (string)
budgetId (string)
allocationId (string)
Content-Type (string) required
data: {
. origin (string)
. reference (string)
. amount (number)
. type (string)
. requestedBy (string)
} (object) required
budgets/post_api_budgets_by_context_type_by_context_id_by_budget_id_allocations_by_allocation_id_transactions_by_transaction_id_refundRefunds a specific transaction from a budget allocation by creating a new CREDIT statement item, which adds funds back to the specified budget allocation. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-contextType (string)
contextId (string)
budgetId (string)
allocationId (string)
transactionId (string)
Content-Type (string) required
data: {
. requestedBy (string)
} (object) required
budgets/get_api_budgets_by_context_type_by_context_id_by_budget_id_allocations_by_allocation_id_transactions_by_transaction_idRetrieves a specific transaction from a budget allocation in the VTEX Budgets API. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this recontextType (string)
contextId (string)
budgetId (string)
allocationId (string)
transactionId (string)
Accept (string) required
budgets/post_api_budgets_by_context_type_by_context_id_by_budget_id_allocations_by_allocation_id_reservationsCreates a temporary reservation under a specific allocation in a VTEX budget. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this requestcontextType (string)
contextId (string)
budgetId (string)
allocationId (string)
Content-Type (string) required
data: {
. origin (string)
. reference (string)
. amount (number)
. requestedBy (string)
. reservationId (string)
. type (string)
} (object) required
budgets/get_api_budgets_by_context_type_by_context_id_by_budget_id_allocations_by_allocation_id_reservationsRetrieves a list of reservations under a specific allocation in a VTEX budget, optionally filtered by status. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be ablecontextType (string)
contextId (string)
budgetId (string)
allocationId (string)
Accept (string) required
page (integer)
pageSize (integer)
status (string)
budgets/get_api_budgets_by_context_type_by_context_id_by_budget_id_allocations_by_allocation_id_reservations_by_reservation_idRetrieves a reservation under a specific allocation in a VTEX budget. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. OtherwcontextType (string)
contextId (string)
budgetId (string)
allocationId (string)
reservationId (string)
Accept (string) required
budgets/delete_api_budgets_by_context_type_by_context_id_by_budget_id_allocations_by_allocation_id_reservations_by_reservation_idCancels a reservation under a specific allocation in a VTEX budget. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. OtherwiscontextType (string)
contextId (string)
budgetId (string)
allocationId (string)
reservationId (string)
Content-Type (string) required
data: {
. requestedBy (string)
} (object) required
budgets/post_api_budgets_by_context_type_by_context_id_by_budget_id_allocations_by_allocation_id_reservations_by_reservation_id_confirmationConfirms a reservation under a specific allocation in a VTEX budget. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. OtherwicontextType (string)
contextId (string)
budgetId (string)
allocationId (string)
reservationId (string)
Content-Type (string) required
data: {
. requestedBy (string)
} (object) required
budgets/post_api_budgets_by_context_type_by_context_id_by_budget_id_allocationsCreates a new allocation within a specific VTEX budget. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, they willcontextType (string)
contextId (string)
budgetId (string)
Content-Type (string) required
data: {
. linkedEntity (object)
. referenceId (string)
. amount (number)
. notificationSettings (object)
} (object) required
budgets/get_api_budgets_by_context_type_by_context_id_by_budget_id_allocationsRetrieves the allocations for a specific budget, with optional filtering by entity type. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run tcontextType (string)
contextId (string)
budgetId (string)
Accept (string) required
type (string)
page (integer)
pageSize (integer)
status (string)
referenceId (string)
budgets/post_api_budgets_by_context_type_by_context_id_by_budget_id_allocations_batchCreates one or more budget allocations in batch under a specific VTEX budget. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this requestcontextType (string)
contextId (string)
budgetId (string)
Content-Type (string) required
data: {
. allocations (array)
} (object) required
budgets/get_api_budgets_by_context_type_by_context_id_by_budget_id_allocations_by_allocation_idRetrieves a specific allocation within a VTEX budget by its ID. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, tcontextType (string)
contextId (string)
budgetId (string)
allocationId (string)
Accept (string) required
budgets/put_api_budgets_by_context_type_by_context_id_by_budget_id_allocations_by_allocation_idUpdates an existing budget allocation within a specific VTEX budget. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. OtherwicontextType (string)
contextId (string)
budgetId (string)
allocationId (string)
Content-Type (string) required
data: {
. linkedEntity (object)
. amount (number)
. referenceId (string)
. contractId (string)
. allocations (array)
. notificationSettings (object)
} (object) required
budgets/delete_api_budgets_by_context_type_by_context_id_by_budget_id_allocations_by_allocation_idDeletes a specific allocation from a budget. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Allocations are not definitively deleted, they are maintained for the sake of record keeping. When looking at statements you will be able to see transaction history for deleted allocations. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the approcontextType (string)
contextId (string)
budgetId (string)
allocationId (string)
Accept (string) required
budgets/put_api_budgets_by_context_type_by_context_id_by_budget_id_allocations_by_allocation_id_linked_entityUpdates the linked entity of a specific allocation within a budget. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. OtherwiscontextType (string)
contextId (string)
budgetId (string)
allocationId (string)
Content-Type (string) required
data: {
. linkedEntityId (string)
. linkedEntityType (string)
} (object) required
budgets/put_api_budgets_by_context_type_by_context_id_by_budget_id_allocations_by_allocation_id_statusUpdates the status of a specific allocation within a budget. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, theycontextType (string)
contextId (string)
budgetId (string)
allocationId (string)
Content-Type (string) required
data: {
. status (string)
} (object) required
budgets/put_api_budgets_by_context_type_by_context_id_by_budget_id_allocations_by_allocation_id_usageUpdates the usage of a specific allocation within a budget. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, theycontextType (string)
contextId (string)
budgetId (string)
allocationId (string)
Content-Type (string) required
data: {
. origin (string)
. reference (string)
. amount (number)
. requestedBy (string)
. type (string)
} (object) required
budgets/post_api_budgets_by_context_type_by_context_id_allocations_queryQueries budget allocations by context and linked entities. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, they wcontextType (string)
contextId (string)
Content-Type (string) required
data: {
. items (array)
} (object) required
budgets/post_api_budgets_by_context_type_by_context_idCreates a new budget with optional allocations and cycle configuration. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. OthecontextType (string)
contextId (string)
Content-Type (string) required
data: {
. name (string)
. description (string)
. amount (number)
. cycleConfiguration (object)
. notificationSettings (object)
. allocations (array)
} (object) required
budgets/get_api_budgets_by_context_type_by_context_idRetrieves a paginated list of budgets filtered by context and amount range. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request.contextType (string)
contextId (string)
Accept (string) required
page (integer)
pageSize (integer)
minAmount (number)
maxAmount (number)
status (string)
name (string)
budgets/get_api_budgets_by_context_type_by_context_id_by_budget_idRetrieves the details of a specific budget. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, they will receive a scontextType (string)
contextId (string)
budgetId (string)
Accept (string) required
budgets/put_api_budgets_by_context_type_by_context_id_by_budget_idUpdates an existing budget. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. ⚠️ Note that you can't update the fields contextType and contextId. You must send the original values, as they are used to validate the request. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorcontextType (string)
contextId (string)
budgetId (string)
Content-Type (string) required
data: {
. name (string)
. description (string)
. amount (number)
. cycleConfiguration (object)
. notificationSettings (object)
} (object) required
budgets/delete_api_budgets_by_context_type_by_context_id_by_budget_idDeletes a specific budget. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, they will receive a status code 403 ercontextType (string)
contextId (string)
budgetId (string)
Accept (string) required
budgets/put_api_budgets_by_context_type_by_context_id_by_budget_id_statusUpdates the status of a specific budget. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, they will receive a statcontextType (string)
contextId (string)
budgetId (string)
Content-Type (string) required
data: {
. status (string)
} (object) required
budgets/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
buyer_organizations/post_api_b2b_import_buyer_orgs⚠️ This endpoint applies to B2B Suite only. Uploads a file for bulk import of Buyer Organizations, Cost Centers and Members. The uploaded file should be in XLSX format and have less than 50MB. For more information on the file structure and how to fill it out, access the Bulk Import Spreadsheethttps://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet guide. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keContent-Type (string) required
an (string)
buyer_organizations/get_api_b2b_import_buyer_orgs_by_import_id⚠️ This endpoint applies to B2B Suite only. Checks the progress of a started file validation or import process. After initiating validation using Validate filehttps://developers.vtex.com/docs/api-reference/buyer-organizations post-/api/b2b/import/buyer-orgs/validate/-importId- or import using Start importhttps://developers.vtex.com/docs/api-reference/buyer-organizations post-/api/b2b/import/buyer-orgs/-importId-, you can track progress by sending a request to this endpoint. PermissionimportId (string)
Content-Type (string) required
an (string)
buyer_organizations/post_api_b2b_import_buyer_orgs_by_import_id⚠️ This endpoint applies to B2B Suite only. Once the file is successfully uploaded and validated, you can call this endpoint to start the import. Provide the importId returned by the Validate filehttps://developers.vtex.com/docs/api-reference/buyer-organizations post-/api/b2b/import/buyer-orgs/validate/-importId- or Upload filehttps://developers.vtex.com/docs/api-reference/buyer-organizations post-/api/b2b/import/buyer-orgs endpoints. Permissions Any user or API keyhttps://developeimportId (string)
Content-Type (string) required
an (string)
buyer_organizations/post_api_b2b_import_buyer_orgs_validate_by_import_id⚠️ This endpoint applies to B2B Suite only. Starts the bulk import file content validation. Once the the file is successfully uploaded, you can start the validation using the importId returned by the Upload filehttps://developers.vtex.com/docs/api-reference/buyer-organizations post-/api/b2b/import/buyer-orgs endpoint. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourcimportId (string)
Content-Type (string) required
an (string)
buyer_organizations/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
buying_policies/servers_by_account_name_authorization_dimensionsNo description availableaccountName (string)
buying_policies/post_by_account_name_authorization_dimensionsCreates a new authorization dimension with its associated rules. Dimensions contain a unitId field that allows grouping of dimensions by units or business areas, enabling more granular authorization control. This field is automatically filled based on the unit relative to the user creating the dimension. If you make this request using an appKey/appToken pair, you must explicitly send the unitId field in the request body root. ❗ While the API supports creating multiple dimensions per unit, theaccountName (string)
Content-Type (string) required
Accept (string) required
data: {
. name (string)
. requireAllRulesAcceptance (boolean)
. unitId (string)
. priority (integer)
. ruleCollection (array)
} (object) required
buying_policies/get_by_account_name_authorization_dimensionsRetrieves a list with dimensions information. You can optionally filter the results using query parameters. Filtering behavior - Exact matching: Only records with exact matches are returned case-insensitive. - Multiple values: You can pass multiple values for the same parameter by repeating it in the query string. For example, https://api.vtexcommercestable.com.br/accountName/authorization-dimensions?name=Dimension name and name=Dimension other name. - Combined filters: Different filter tyaccountName (string)
id (array)
unitId (array)
name (array)
Accept (string) required
buying_policies/servers_by_account_name_authorization_dimensions_by_dimension_idNo description availableaccountName (string)
dimensionId (string)
buying_policies/put_by_account_name_authorization_dimensions_by_dimension_idUpdates a specific authorization dimension. ℹ️ For more information about approval dynamic, and dimension and rule priorities, see the Buying Policies API overviewhttps://developers.vtex.com/docs/api-reference/buying-policies-api. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to baccountName (string)
dimensionId (string)
Content-Type (string) required
Accept (string) required
data: {
. name (string)
. requireAllRulesAcceptance (boolean)
. unitId (string)
. priority (integer)
. ruleCollection (array)
} (object) required
buying_policies/delete_by_account_name_authorization_dimensions_by_dimension_idDeletes a specific dimension by its ID. ℹ️ For more information about approval dynamic, and dimension and rule priorities, see the Buying Policies API overviewhttps://developers.vtex.com/docs/api-reference/buying-policies-api. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be abaccountName (string)
dimensionId (string)
Accept (string) required
buying_policies/servers_by_account_name_authorization_dimensions_by_dimension_id_rulesNo description availableaccountName (string)
dimensionId (string)
buying_policies/post_by_account_name_authorization_dimensions_by_dimension_id_rulesRegisters a new dimension rule. ℹ️ For more information about approval dynamic, and dimension and rule priorities, see the Buying Policies API overviewhttps://developers.vtex.com/docs/api-reference/buying-policies-api. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to suaccountName (string)
dimensionId (string)
Content-Type (string) required
Accept (string) required
data: {
. name (string)
. priority (integer)
. trigger (object)
. scoreInterval (object)
. authorizationData (object)
} (object) required
buying_policies/put_by_account_name_authorization_dimensions_by_dimension_id_rulesReplaces all existing rules in a dimension with the provided array of rules. ℹ️ For more information about approval dynamic, and dimension and rule priorities, see the Buying Policies API overviewhttps://developers.vtex.com/docs/api-reference/buying-policies-api. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resouaccountName (string)
dimensionId (string)
Content-Type (string) required
Accept (string) required
data (array) required
buying_policies/servers_by_account_name_authorization_dimensions_by_dimension_id_rules_by_rule_idNo description availableaccountName (string)
dimensionId (string)
ruleId (string)
buying_policies/put_by_account_name_authorization_dimensions_by_dimension_id_rules_by_rule_idUpdates a specific rule within an authorization dimension. ℹ️ For more information about approval dynamic, and dimension and rule priorities, see the Buying Policies API overviewhttps://developers.vtex.com/docs/api-reference/buying-policies-api. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQaccountName (string)
dimensionId (string)
ruleId (string)
Content-Type (string) required
Accept (string) required
data: {
. name (string)
. priority (integer)
. trigger (object)
. scoreInterval (object)
. authorizationData (object)
} (object) required
buying_policies/delete_by_account_name_authorization_dimensions_by_dimension_id_rules_by_rule_idDeletes a specific dimension rule. ℹ️ For more information about approval dynamic, and dimension and rule priorities, see the Buying Policies API overviewhttps://developers.vtex.com/docs/api-reference/buying-policies-api. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able toaccountName (string)
dimensionId (string)
ruleId (string)
Accept (string) required
buying_policies/servers_commercial_authorizations_by_order_auth_id_callbackNo description availableorderAuthId (string)
buying_policies/post_commercial_authorizations_by_order_auth_id_callbackAccepts or denies a pending dimension rule, a manual approval required for rules with effectType: 2 pending. When a rule requires manual authorization, you call this endpoint with a score value that is compared against the rule's scoreInterval thresholds. The score value is configured using the Create dimensionhttps://developers.vtex.com/docs/api-reference/buying-policies-api post-/-accountName-/authorization-dimensions and Update dimensionhttps://developers.vtex.com/docs/api-reference/buying-orderAuthId (string)
Content-Type (string) required
Accept (string) required
data: {
. params (object)
} (object) required
buying_policies/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
card_token_vault/post_api_card_token_vault_tokensRegisters a new card token in the Card Token Vault CTV. ⚠️ This feature is in closed beta, meaning only specific customers can access it now. If you want to implement it in the future, please contact our Supporthttps://support.vtex.com/hc/en-us/. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8Content-Type (string) required
Accept (string) required
data: {
. providerId (string)
. profileId (string)
. shopperId (string)
. email (string)
. orderGroup (string)
. card
. cardTokenData
. extraData (object)
} (object) required
card_token_vault/put_api_card_token_vault_tokens_by_idUpdates data for an existing token in the Card Token Vault CTV. ⚠️ This feature is in closed beta, meaning only specific customers can access it now. If you want to implement it in the future, please contact our Supporthttps://support.vtex.com/hc/en-us/. This endpoint requires sending the complete request body from the Create Card Token endpoint, except for the card object. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys musid (string)
Content-Type (string) required
Accept (string) required
data: {
. providerId (string)
. profileId (string)
. shopperId (string)
. email (string)
. orderGroup (string)
. cardTokenData
. extraData (object)
} (object) required
card_token_vault/get_api_payments_pvt_accounts_by_idRetrieves data for a specific token by its ID unique identifier automatically generated during token creation. ⚠️ This feature is in closed beta, meaning only specific customers can access it now. If you want to implement it in the future, please contact our Supporthttps://support.vtex.com/hc/en-us/. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vid (string)
Content-Type (string) required
Accept (string) required
card_token_vault/delete_api_payments_pvt_accounts_by_idDeletes a card token in the Card Token Vault CTV. ⚠️ This feature is in closed beta, meaning only specific customers can access it now. If you want to implement it in the future, please contact our Supporthttps://support.vtex.com/hc/en-us/. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6id (string)
Content-Type (string) required
Accept (string) required
card_token_vault/post_api_card_token_vault_tokens_importImports tokens in bulk using an XLSX file. ⚠️ This feature is in closed beta, meaning only specific customers can access it now. If you want to implement it in the future, please contact our Supporthttps://support.vtex.com/hc/en-us/. Before starting an import process, it's important to consider the following requirements and behavioral rules: - File requirements: Only .xlsx files up to 20 MB are supported. - Simultaneous imports: Each account can trigger only one import operation at a tAccept (string) required
card_token_vault/get_api_card_token_vault_tokens_import_by_import_idReturns the status and progress percentage of an import. ⚠️ This feature is in closed beta, meaning only specific customers can access it now. If you want to implement it in the future, please contact our Supporthttps://support.vtex.com/hc/en-us/. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrCimportId (string)
Content-Type (string) required
Accept (string) required
card_token_vault/get_api_card_token_vault_tokens_import_by_import_id_reportReturns the import report, indicating lines with issues. ⚠️ This feature is in closed beta, meaning only specific customers can access it now. If you want to implement it in the future, please contact our Supporthttps://support.vtex.com/hc/en-us/. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrCimportId (string)
Content-Type (string) required
Accept (string) required
card_token_vault/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
catalog_api_seller_portal/get_api_catalog_seller_portal_products_by_product_id📘 This API is part of the Seller Portal Cataloghttps://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp. This functionality is in the beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Centerhttps://support.vtex.com/hc/en-us/requests. Retrieves general information about a product by its ID. TheproductId (string)
Content-Type (string) required
Accept (string) required
catalog_api_seller_portal/put_api_catalog_seller_portal_products_by_product_id📘 This API is part of the Seller Portal Cataloghttps://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp. This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Centerhttps://support.vtex.com/hc/en-us/requests. Updates an existing product and its SKUs. PermissionsproductId (string)
Content-Type (string) required
Accept (string) required
data: {
. id (string)
. externalId (string)
. status (string)
. name (string)
. brandId (string)
. description (string)
. categoryIds (array)
. specs (array)
. attributes (array)
. slug (string)
. transportModal (string)
. taxCode (string)
. images (array)
. skus (array)
. origin (string)
} (object) required
catalog_api_seller_portal/get_api_catalog_seller_portal_products_by_product_id_description📘 This API is part of the Seller Portal Cataloghttps://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp. This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Center.https://support.vtex.com/hc/en-us/requests Retrieves the description of a product given a product ID.productId (string)
Content-Type (string) required
Accept (string) required
catalog_api_seller_portal/put_api_catalog_seller_portal_products_by_product_id_description📘 This API is part of the Seller Portal Cataloghttps://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp. This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Centerhttps://support.vtex.com/hc/en-us/requests. Updates the description of a product given a product ID.productId (string)
Content-Type (string) required
Accept (string) required
data: {
. productId (string)
. description (string)
} (object) required
catalog_api_seller_portal/get_api_catalog_seller_portal_products_by_param📘 This API is part of the Seller Portal Cataloghttps://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp. This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Centerhttps://support.vtex.com/hc/en-us/requests. Retrieves general information about a product by its externaparam (string)
Content-Type (string) required
Accept (string) required
catalog_api_seller_portal/post_api_catalog_seller_portal_products📘 This API is part of the Seller Portal Cataloghttps://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp. This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Centerhttps://support.vtex.com/hc/en-us/requests. Creates a new product and its SKUs. Permissions AnyContent-Type (string) required
Accept (string) required
data: {
. externalId (string)
. status (string)
. name (string)
. brandId (string)
. description (string)
. categoryIds (array)
. specs (array)
. attributes (array)
. slug (string)
. images (array)
. skus (array)
. origin (string)
. transportModal (string)
. taxCode (string)
} (object) required
catalog_api_seller_portal/get_api_catalog_seller_portal_skus_search📘 This API is part of the Seller Portal Cataloghttps://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp. This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Centerhttps://support.vtex.com/hc/en-us/requests. Retrieves general information about an SKU taking into consiContent-Type (string) required
Accept (string) required
from (string)
to (string)
id (integer)
externalid (integer)
catalog_api_seller_portal/get_api_catalog_seller_portal_skus_ids📘 This API is part of the Seller Portal Cataloghttps://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp. This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Centerhttps://support.vtex.com/hc/en-us/requests. Retrieves general information about all SKUs. PermissiContent-Type (string) required
Accept (string) required
from (string)
to (string)
catalog_api_seller_portal/get_api_catalog_seller_portal_brands📘 This API is part of the Seller Portal Cataloghttps://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp. This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Centerhttps://support.vtex.com/hc/en-us/requests. Retrieves general information about all brands of the store.Content-Type (string) required
Accept (string) required
q (string)
from (string)
to (string)
orderBy (string)
name (string)
catalog_api_seller_portal/post_api_catalog_seller_portal_brands📘 This API is part of the Seller Portal Cataloghttps://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp. This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Centerhttps://support.vtex.com/hc/en-us/requests. Creates a new brand. Permissions Any user or API keContent-Type (string) required
Accept (string) required
data: {
. name (string)
. isActive (boolean)
} (object) required
catalog_api_seller_portal/get_api_catalog_seller_portal_brands_by_brand_id📘 This API is part of the Seller Portal Cataloghttps://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp. This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Centerhttps://support.vtex.com/hc/en-us/requests. Retrieves general information about a brand by its ID.brandId (string)
Content-Type (string) required
Accept (string) required
catalog_api_seller_portal/put_api_catalog_seller_portal_brands_by_brand_id📘 This API is part of the Seller Portal Cataloghttps://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp. This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Centerhttps://support.vtex.com/hc/en-us/requests. Updates an existing brand. Permissions Any user orbrandId (string)
Content-Type (string) required
Accept (string) required
data: {
. id (string)
. name (string)
. isActive (boolean)
} (object) required
catalog_api_seller_portal/get_api_catalog_seller_portal_category_tree📘 This API is part of the Seller Portal Cataloghttps://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp. This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Centerhttps://support.vtex.com/hc/en-us/requests. Retrieves general information about the category tree from tContent-Type (string) required
Accept (string) required
depth (integer)
catalog_api_seller_portal/put_api_catalog_seller_portal_category_tree📘 This API is part of the Seller Portal Cataloghttps://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp. This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Centerhttps://support.vtex.com/hc/en-us/requests. Updates the existing categories in the category tree.Content-Type (string) required
Accept (string) required
data: {
. roots (array)
} (object) required
catalog_api_seller_portal/get_api_catalog_seller_portal_category_tree_categories_by_category_id📘 This API is part of the Seller Portal Cataloghttps://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp. This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Centerhttps://support.vtex.com/hc/en-us/requests. Retrieves general information about a category by its ID.categoryId (string)
Content-Type (string) required
Accept (string) required
catalog_api_seller_portal/post_api_catalog_seller_portal_category_tree_categories📘 This API is part of the Seller Portal Cataloghttps://help.vtex.com/en/tutorial/how-the-seller-portal-catalog-works--7pMB6YOt6YQDQQbzFB4Pxp. This functionality is in the Beta stage and can be discontinued at any moment at VTEX's discretion. VTEX will not be responsible for any instabilities caused by its use or discontinuity. If you have any questions, please contact our Support Centerhttps://support.vtex.com/hc/en-us/requests. Creates a new category. Permissions Any user or APIContent-Type (string) required
Accept (string) required
data: {
. parentId (string)
. Name (string)
} (object) required
catalog_api_seller_portal/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
catalog/get_api_catalog_system_pvt_products_get_product_and_sku_idsRetrieves the IDs of products and SKUs. ⚠️ The response body is limited to 250 records, but you can use the query params _from and _to. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 errorcategoryId (integer)
_from (integer)
_to (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_pvt_product_by_product_idRetrieves a specific product by its ID. The response body fields are exactly the information needed to create a new product. 📘 Onboarding guide Check the Catalog onboarding guidehttps://developers.vtex.com/vtex-rest-api/docs/catalog-overview. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. Permissions Any user or API keproductId (string)
Content-Type (string) required
Accept (string) required
catalog/put_api_catalog_pvt_product_by_product_idUpdates an existing product. ❗ Although some fields are not required to get a response 200 OK, if you don't send a field or send its value as empty or null, all previously configured information will be deleted, and boolean fields will turn to false. So, to update a product, you should get its data using the Get product by IDhttps://developers.vtex.com/docs/api-reference/catalog-api get-/api/catalog/pvt/product/-productId- endpoint and use it as a template for the current request body.productId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Name (string)
. DepartmentId (integer)
. CategoryId (integer)
. BrandId (integer)
. LinkId (string)
. RefId (string)
. IsVisible (boolean)
. Description (string)
. DescriptionShort (string)
. ReleaseDate (string)
. KeyWords (string)
. Title (string)
. IsActive (boolean)
. TaxCode (string)
. MetaTagDescription (string)
. SupplierId (integer)
. ShowWithoutStock (boolean)
. AdWordsRemarketingCode (string)
. LomadeeCampaignCode (string)
. Score (integer)
} (object) required
catalog/get_api_catalog_system_pvt_products_productget_by_product_idRetrieves a specific product's general information as name, description and the sales channels where it is included. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicproductId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_system_pvt_products_productgetbyrefid_by_ref_idRetrieves a specific product by its Reference ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResourcrefId (string)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_system_pub_products_variations_by_product_idRetrieves data about a product and its SKUs, given the product ID. A SKU Stock Keeping Unit is the physical unit of the product, also called a product variation. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receiveproductId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_addon_pvt_review_get_product_rate_by_product_idRetrieves the review rate of a product given the product's ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategproductId (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_productThis endpoint allows two types of request: Type 1: Creating a new product as well as a new category path including subcategories and a new brand by using CategoryPath and BrandName parameters. Type 2: Creating a new product given an existing BrandId and an existing CategoryId. When creating a product, regardless of the type of request, if there is a need to create a new product with a specific custom product ID, specify the Id integer in the request body. Otherwise, VTEX will generate tContent-Type (string) required
Accept (string) required
data (undefined) required
catalog/get_api_catalog_system_pvt_products_by_product_id_specificationRetrieves all specifications of a product by the product's ID. 📘 Onboarding guide Check the new Catalog onboarding guidehttps://developers.vtex.com/vtex-rest-api/docs/catalog-overview. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authenticationproductId (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_system_pvt_products_by_product_id_specificationUpdates the value of a product specification by the product's ID. The specification's ID or name can be used to identify what product specification will be updated. specification fields must be previously created in your Catalog. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to beproductId (integer)
Content-Type (string) required
Accept (string) required
data (array) required
catalog/get_api_catalog_pvt_product_by_product_id_specificationRetrieves information of all specifications of a product by the product's ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: |productId (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_product_by_product_id_specificationAssociates a previously defined specification to a product. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategoryproductId (integer)
Content-Type (string) required
Accept (string) required
data: {
. FieldId (integer)
. FieldValueId (integer)
. Text (string)
} (object) required
catalog/delete_api_catalog_pvt_product_by_product_id_specificationDeletes all product specifications given a specific product ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CateproductId (integer)
Content-Type (string) required
Accept (string) required
catalog/delete_api_catalog_pvt_product_by_product_id_specification_by_specification_idDeletes a product specification given a product ID productId and a specification ID specificationId. For specifications with predefined values such as radio, checkbox, or combo, you must use the specification field ID specificationFieldId instead. Otherwise, the request will return a 404 Not Found status code. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps:/productId (integer)
specificationId (integer)
Content-Type (string) required
Accept (string) required
catalog/put_api_catalog_pvt_product_by_product_id_specificationvalueAssociates a specification to a product using specification name and group name. Automatically creates the informed group, specification and values if they had not been created before. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. OtherproductId (integer)
Content-Type (string) required
Accept (string) required
data: {
. FieldName (string)
. GroupName (string)
. RootLevelSpecification (boolean)
. FieldValues (array)
} (object) required
catalog/get_api_catalog_system_pvt_sku_stockkeepingunitidsRetrieves the IDs of all SKUs in your store. Presents the results with page size and pagination. 📘 Onboarding guide Check the new Catalog onboarding guidehttps://developers.vtex.com/vtex-rest-api/docs/catalog-overview. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. Permissions Any user or API keyhttps://developers.vtex.page (integer) required
pagesize (integer) required
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_system_pvt_sku_stockkeepingunitbyid_by_sku_idRetrieves context of an SKU. 📘 Onboarding guide Check the new Catalog onboarding guidehttps://developers.vtex.com/vtex-rest-api/docs/catalog-overview. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at leastskuId (integer)
Content-Type (string) required
Accept (string) required
sc (integer)
catalog/get_api_catalog_pvt_stockkeepingunitRetrieves information about a specific SKU by its RefId. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category |Content-Type (string) required
Accept (string) required
RefId (string) required
catalog/post_api_catalog_pvt_stockkeepingunitCreates a new SKU. If there is a need to create a new SKU with a specific custom ID, specify the Id integer in the request. Otherwise, VTEX will generate the ID automatically. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise tContent-Type (string) required
Accept (string) required
data: {
. Id (integer)
. ProductId (integer)
. IsActive (boolean)
. ActivateIfPossible (boolean)
. Name (string)
. RefId (string)
. PackagedHeight (number)
. PackagedLength (number)
. PackagedWidth (number)
. PackagedWeightKg (integer)
. Height (number)
. Length (number)
. Width (number)
. WeightKg (number)
. CubicWeight (number)
. IsKit (boolean)
. CreationDate (string)
. RewardValue (number)
. EstimatedDateArrival (string)
. ManufacturerCode (string)
. CommercialConditionId (integer)
. MeasurementUnit (string)
. UnitMultiplier (number)
. ModalType (string)
. KitItensSellApart (boolean)
. Videos (array)
} (object) required
catalog/get_api_catalog_system_pvt_sku_stockkeepingunitidbyrefid_by_ref_idRetrieves an SKU ID by the SKU's reference ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource |refId (string)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_system_pvt_sku_stockkeepingunitbyalternate_id_by_alternate_idRetrieves an SKU by its alternate ID, which can be the EAN or the reference ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:alternateId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_system_pvt_sku_stockkeepingunit_by_product_id_by_product_idRetrieves a list with the SKUs related to a product by the product's ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | ProduproductId (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_system_pub_sku_stockkeepingunitidsbyrefidsGiven a list of reference IDs, this endpoint returns a list with the corresponding SKU IDs. ⚠️ The list of reference IDs in the request body cannot have repeated reference IDs, or the API will return an error 500. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to succContent-Type (string) required
Accept (string) required
data (array) required
catalog/get_api_catalog_pvt_stockkeepingunit_by_sku_idRetrieves a specific SKU by its ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -------skuId (integer)
Content-Type (string) required
Accept (string) required
catalog/put_api_catalog_pvt_stockkeepingunit_by_sku_idUpdates an existing SKU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --------------- |skuId (integer)
Content-Type (string) required
Accept (string) required
data: {
. ProductId (integer)
. IsActive (boolean)
. ActivateIfPossible (boolean)
. Name (string)
. RefId (string)
. PackagedHeight (number)
. PackagedLength (number)
. PackagedWidth (number)
. PackagedWeightKg (integer)
. Height (number)
. Length (number)
. Width (number)
. WeightKg (number)
. CubicWeight (number)
. IsKit (boolean)
. CreationDate (string)
. RewardValue (number)
. EstimatedDateArrival (string)
. ManufacturerCode (string)
. CommercialConditionId (integer)
. MeasurementUnit (string)
. UnitMultiplier (number)
. ModalType (string)
. KitItensSellApart (boolean)
. Videos (array)
} (object) required
catalog/get_api_catalog_pvt_stockkeepingunit_by_sku_id_complementRetrieves an existing SKU complement by its SKU ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResouskuId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_pvt_stockkeepingunit_by_sku_id_complement_by_complement_type_idRetrieves all the existing SKU complements with the same complement type ID of a specific SKU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for thiskuId (integer)
complementTypeId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_system_pvt_sku_complements_by_parent_sku_id_by_typeRetrieves all the existing SKU complements with the same complement type ID of a specific SKU and parent SKU ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicableparentSkuId (integer)
type (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_skucomplementCreates a new SKU complement on a parent SKU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource |Content-Type (string) required
Accept (string) required
data: {
. ParentSkuId (integer)
. SkuId (integer)
. ComplementTypeId (integer)
} (object) required
catalog/get_api_catalog_pvt_skucomplement_by_sku_complement_idRetrieves an existing SKU complement by its SKU complement ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategskuComplementId (integer)
Content-Type (string) required
Accept (string) required
catalog/delete_api_catalog_pvt_skucomplement_by_sku_complement_idDeletes a previously existing SKU complement by SKU complement ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CskuComplementId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_system_pvt_sku_stockkeepingunitbyean_by_eanRetrieves an SKU by its EAN ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -----------ean (string)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_pvt_stockkeepingunit_by_sku_id_eanRetrieves the EAN of the SKU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -------------skuId (integer)
Content-Type (string) required
Accept (string) required
catalog/delete_api_catalog_pvt_stockkeepingunit_by_sku_id_eanDeletes all EAN values of an SKU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | ---------skuId (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_stockkeepingunit_by_sku_id_ean_by_eanCreates the EAN value of an SKU. It is not possible to update the EAN. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | ProductskuId (integer)
ean (string)
Content-Type (string) required
Accept (string) required
catalog/delete_api_catalog_pvt_stockkeepingunit_by_sku_id_ean_by_eanDeletes the EAN value of an SKU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | ----------skuId (integer)
ean (string)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_skuattachmentAssociates an existing SKU to an existing attachment. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResContent-Type (string) required
Accept (string) required
data: {
. AttachmentId (integer)
. SkuId (integer)
} (object) required
catalog/delete_api_catalog_pvt_skuattachmentDissociates attachments and SKUs based on an SKU ID or an attachment ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | ProduContent-Type (string) required
Accept (string) required
skuId (integer)
attachmentId (integer)
catalog/get_api_catalog_pvt_stockkeepingunit_by_sku_id_attachmentRetrieves existing SKU attachments by SKU ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource |skuId (integer)
Content-Type (string) required
Accept (string) required
catalog/delete_api_catalog_pvt_skuattachment_by_sku_attachment_association_idDeletes the association of an SKU to an attachment. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResouskuAttachmentAssociationId (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_system_pvt_sku_associateattachmentsAssociates attachments to an SKU based on a given SKU ID and attachment names. This request removes existing SKU attachment associations and recreates the associations with the attachments being sent. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run thContent-Type (string) required
Accept (string) required
data: {
. SkuId (integer)
. AttachmentNames (array)
} (object) required
catalog/get_api_catalog_pvt_stockkeepingunit_by_sku_id_fileRetrieves general information about all files in the SKU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category |skuId (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_stockkeepingunit_by_sku_id_fileCreates a new image for an SKU based on its URL or on a form-data request body. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:skuId (integer)
Content-Type (string) required
Accept (string) required
data: {
. IsMain (boolean)
. Label (string)
. Name (string)
. Text (string)
. Url (string)
. Position (integer)
} (object) required
catalog/delete_api_catalog_pvt_stockkeepingunit_by_sku_id_fileDeletes all SKU image files. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --------------skuId (integer)
Content-Type (string) required
Accept (string) required
catalog/put_api_catalog_pvt_stockkeepingunit_by_sku_id_file_by_sku_file_idUpdates a new image on an SKU based on its URL or on a form-data request body. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: |skuId (integer)
skuFileId (integer)
Content-Type (string) required
Accept (string) required
data: {
. IsMain (boolean)
. Label (string)
. Name (string)
. Text (string)
. Url (string)
. Position (integer)
} (object) required
catalog/delete_api_catalog_pvt_stockkeepingunit_by_sku_id_file_by_sku_file_idDeletes a specific SKU image file. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --------skuId (integer)
skuFileId (integer)
Content-Type (string) required
Accept (string) required
catalog/put_api_catalog_pvt_stockkeepingunit_by_sku_id_file_reorderDefines SKU images positions. For the request to work properly, you must send all SKU images positions. For example, if the SKU has 10 images, you have to send in the request all file IDs and positions. There is no need to send them in order, but all positions must be defined. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/licenseskuId (integer)
Content-Type (string) required
Accept (string) required
data (array) required
catalog/put_api_catalog_pvt_stockkeepingunit_copy_by_sku_idfrom_by_sku_idto_fileCopy all existing files from an SKU to another SKU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResouskuIdfrom (integer)
skuIdto (integer)
Content-Type (string) required
Accept (string) required
catalog/delete_api_catalog_pvt_stockkeepingunit_disassociate_by_sku_id_file_by_sku_file_idDisassociates an SKU file from an SKU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | ----skuId (integer)
skuFileId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_pvt_stockkeepingunitkitRetrieves general information about the components of an SKU kit by SKU ID or parent SKU ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for thisContent-Type (string) required
Accept (string) required
skuId (integer)
parentSkuId (integer)
catalog/post_api_catalog_pvt_stockkeepingunitkitAdds a component to a specific kit. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -------Content-Type (string) required
Accept (string) required
data: {
. StockKeepingUnitParent (integer)
. StockKeepingUnitId (integer)
. Quantity (integer)
. UnitPrice (number)
} (object) required
catalog/delete_api_catalog_pvt_stockkeepingunitkitDeletes all kit's components based on the parent SKU ID or deletes a specific kit's component based on the SKU ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicabContent-Type (string) required
Accept (string) required
skuId (integer)
parentSkuId (integer)
catalog/get_api_catalog_pvt_stockkeepingunitkit_by_kit_idRetrieves general information about a component of a kit. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category |kitId (integer)
Content-Type (string) required
Accept (string) required
catalog/delete_api_catalog_pvt_stockkeepingunitkit_by_kit_idDeletes a specific kit's component based on its kit ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | RkitId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_system_pvt_skuseller_by_seller_id_by_seller_sku_id⚠️ Check out the updated version of this endpoint in our SKU Bindings API documentationhttps://developers.vtex.com/docs/api-reference/sku-bindings-api get-/sku-binding/pvt/skuseller/-sellerId-/-sellerSkuId-. If you are doing this integration for the first time, we recommend that you follow the updated documentation. Retrieves the details of a seller's SKU given a seller ID and the SKU ID in the seller's store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/apisellerId (string)
sellerSkuId (string)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_system_pvt_skuseller_remove_by_seller_id_by_seller_sku_id⚠️ Check out the updated version of this endpoint in our SKU Bindings API documentationhttps://developers.vtex.com/docs/api-reference/sku-bindings-api post-/sku-binding/pvt/skuseller/remove/-sellerId-/-sellerSkuId-. If you are doing this integration for the first time, we recommend that you follow the updated documentation. Remove a seller's SKU binding, given the seller ID and the SKU ID in the seller's store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/apsellerId (string)
sellerSkuId (string)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_system_pvt_skuseller_changenotification_by_seller_id_by_seller_sku_id⚠️ Check out the updated version of this endpoint in our SKU Bindings API documentationhttps://developers.vtex.com/docs/api-reference/sku-bindings-api post-/sku-binding/pvt/skuseller/changenotification/-sellerId-/-sellerSkuId-. If you are doing this integration for the first time, we recommend that you follow the updated documentation. The seller is responsible for suggesting new SKUs to be sold in the VTEX marketplace and also for informing the marketplace about changes in their SKUs that alsellerId (string)
sellerSkuId (string)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_system_pvt_skuseller_changenotification_by_sku_id⚠️ Check out the updated version of this endpoint in our SKU Bindings API documentationhttps://developers.vtex.com/docs/api-reference/sku-bindings-api post-/sku-binding/pvt/skuseller/changenotification/-skuId-. If you are doing this integration for the first time, we recommend that you follow the updated documentation. The seller is responsible for suggesting new SKUs to be sold in the VTEX marketplace and also for informing the marketplace about changes in their SKUs that already exist inskuId (string)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_stockkeepingunit_by_sku_id_attributeCreates an attribute for an SKU, which is an informative field at the SKU level that doesn't create new variants. For example, a lipstick might have color and size as structured specifications that define SKU variants, while ingredients would be an informative attribute since they don't represent a new SKU. ⚠️ Attributes only accept open-text values. The maximum length for SpecificationValue is 3,500 characters. If the request body contains characters that break the JSON string for example, uskuId (integer)
Content-Type (string) required
Accept (string) required
data: {
. SpecificationName (string)
. SpecificationValue (string)
. IsVisible (boolean)
} (object) required
catalog/get_api_catalog_pvt_stockkeepingunit_by_sku_id_attributeRetrieves all SKU attributes, which are informative fields defined at the SKU level that don't create new SKU variants. They only accept open-text values. ℹ️ These attributes are indexed and can be retrieved in the attribute field of the search payload. However, they cannot be used as search filters or searched directly in the storefront. In the storefront context, they are available in the additionalProperty field and can be differentiated from regular specifications by the valueReference fiskuId (integer)
Content-Type (string) required
Accept (string) required
catalog/delete_api_catalog_pvt_stockkeepingunit_by_sku_id_attributeDeletes all attributes of an SKU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | ---------skuId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_pvt_stockkeepingunit_by_sku_id_attribute_by_sku_attribute_idRetrieves a specific attribute of an SKU by its unique identifier. SKU attributes are informative fields defined at the SKU level that don't create new SKU variants. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receskuId (integer)
skuAttributeId (integer)
Content-Type (string) required
Accept (string) required
catalog/put_api_catalog_pvt_stockkeepingunit_by_sku_id_attribute_by_sku_attribute_idUpdates an existing attribute of an SKU. ⚠️ SKU attributes only accept open-text values. The maximum length for SpecificationValue is 3,500 characters. If the request body contains characters that break the JSON string for example, unescaped backslashes, the request will fail with a status code 400 error. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://hskuId (integer)
skuAttributeId (integer)
Content-Type (string) required
Accept (string) required
data: {
. SpecificationName (string)
. SpecificationValue (string)
. IsVisible (boolean)
} (object) required
catalog/delete_api_catalog_pvt_stockkeepingunit_by_sku_id_attribute_by_sku_attribute_idDeletes a specific attribute of an SKU by its unique identifier. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CatskuId (integer)
skuAttributeId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_pvt_skuservice_by_sku_service_idRetrieves an SKU service. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --------------- |skuServiceId (integer)
Content-Type (string) required
Accept (string) required
catalog/put_api_catalog_pvt_skuservice_by_sku_service_idUpdates an SKU service. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --------------- | -skuServiceId (integer)
Content-Type (string) required
Accept (string) required
data: {
. SkuServiceTypeId (integer)
. SkuServiceValueId (integer)
. SkuId (integer)
. Name (string)
. Text (string)
. IsActive (boolean)
} (object) required
catalog/delete_api_catalog_pvt_skuservice_by_sku_service_idDissociates an SKU service from an SKU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | ---skuServiceId (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_skuserviceAssociates an SKU service to an SKU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | ------Content-Type (string) required
Accept (string) required
data: {
. SkuServiceTypeId (integer)
. SkuServiceValueId (integer)
. SkuId (integer)
. Name (string)
. Text (string)
. IsActive (boolean)
} (object) required
catalog/post_api_catalog_pvt_skuservicetypeattachmentAssociates an Attachment for an existing SKU service type. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategoryContent-Type (string) required
Accept (string) required
data: {
. AttachmentId (integer)
. SkuServiceTypeId (integer)
} (object) required
catalog/delete_api_catalog_pvt_skuservicetypeattachmentDissociates an attachment by its attachment ID or SKU service type ID from an SKU service type. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for thContent-Type (string) required
Accept (string) required
attachmentId (integer)
skuServiceTypeId (integer)
catalog/delete_api_catalog_pvt_skuservicetypeattachment_by_sku_service_type_attachment_idDissociates an attachment from an SKU service type. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResouskuServiceTypeAttachmentId (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_skuservicetypeCreates a new SKU service type. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -----------Content-Type (string) required
Accept (string) required
data: {
. Name (string)
. IsActive (boolean)
. ShowOnProductFront (boolean)
. ShowOnCartFront (boolean)
. ShowOnAttachmentFront (boolean)
. ShowOnFileUpload (boolean)
. IsGiftCard (boolean)
. IsRequired (boolean)
} (object) required
catalog/get_api_catalog_pvt_skuservicetype_by_sku_service_type_idRetrieves information about an existing SKU service type. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category |skuServiceTypeId (integer)
Content-Type (string) required
Accept (string) required
catalog/put_api_catalog_pvt_skuservicetype_by_sku_service_type_idUpdates an existing SKU service type. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -----skuServiceTypeId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Name (string)
. IsActive (boolean)
. ShowOnProductFront (boolean)
. ShowOnCartFront (boolean)
. ShowOnAttachmentFront (boolean)
. ShowOnFileUpload (boolean)
. IsGiftCard (boolean)
. IsRequired (boolean)
} (object) required
catalog/delete_api_catalog_pvt_skuservicetype_by_sku_service_type_idDeletes an existing SKU service type. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -----skuServiceTypeId (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_skuservicevalueCreates an SKU service value for an existing SKU service type. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategContent-Type (string) required
Accept (string) required
data: {
. SkuServiceTypeId (integer)
. Name (string)
. Value (number)
. Cost (number)
} (object) required
catalog/get_api_catalog_pvt_skuservicevalue_by_sku_service_value_idRetrieves an existing SKU service value. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --skuServiceValueId (integer)
Content-Type (string) required
Accept (string) required
catalog/put_api_catalog_pvt_skuservicevalue_by_sku_service_value_idUpdates an existing SKU service value. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | ----skuServiceValueId (integer)
Content-Type (string) required
Accept (string) required
data: {
. SkuServiceTypeId (integer)
. Name (string)
. Value (number)
. Cost (number)
} (object) required
catalog/delete_api_catalog_pvt_skuservicevalue_by_sku_service_value_idDeletes an existing SKU service value. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | ----skuServiceValueId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_pvt_stockkeepingunit_by_sku_id_specificationRetrieves information about an SKU's specifications. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResoskuId (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_stockkeepingunit_by_sku_id_specificationAssociates a previously created specification to an SKU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category |skuId (integer)
Content-Type (string) required
Accept (string) required
data: {
. FieldId (integer)
. FieldValueId (integer)
} (object) required
catalog/put_api_catalog_pvt_stockkeepingunit_by_sku_id_specificationUpdates an existing specification on an existing SKU. This endpoint only updates the FieldValueId. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources forskuId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Id (integer)
. SkuId (integer)
. FieldId (integer)
. FieldValueId (integer)
. Text (string)
} (object) required
catalog/delete_api_catalog_pvt_stockkeepingunit_by_sku_id_specificationDeletes all SKU specifications. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -----------skuId (integer)
Content-Type (string) required
Accept (string) required
catalog/delete_api_catalog_pvt_stockkeepingunit_by_sku_id_specification_by_specification_idDeletes a specific SKU specification. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -----skuId (integer)
specificationId (integer)
Content-Type (string) required
Accept (string) required
catalog/put_api_catalog_pvt_stockkeepingunit_by_sku_id_specificationvalueAssociates a specification to an SKU using specification name and group name. Automatically creates the informed group, specification and values if they had not been created before. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. OtherwisskuId (integer)
Content-Type (string) required
Accept (string) required
data: {
. FieldName (string)
. GroupName (string)
. RootLevelSpecification (boolean)
. FieldValues (array)
} (object) required
catalog/post_api_catalog_pvt_subcollection_by_sub_collection_id_stockkeepingunit⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections configured through the Legacy CMS Portalhttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L. Associates a single SKU to a Subcollection, which is a Grouphttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L group-types within a Collection. Permissions Any user or API keyhttpssubCollectionId (integer)
Content-Type (string) required
Accept (string) required
data: {
. SkuId (integer)
} (object) required
catalog/delete_api_catalog_pvt_subcollection_by_sub_collection_id_stockkeepingunit_by_sku_id⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections configured through the Legacy CMS Portalhttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L. Deletes an SKU from a Subcollection, which is a Grouphttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L group-types within a Collection. Permissions Any user or API keyhttps://devesubCollectionId (integer)
skuId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_system_pub_category_tree_by_category_levelsRetrieves the category tree of your store. Get all the category levels registered in the Catalog or define the level up to which you want to get. 📘 Onboarding guide Check the new Catalog onboarding guidehttps://developers.vtex.com/vtex-rest-api/docs/catalog-overview. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. PermisscategoryLevels (string)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_pvt_category_by_category_idRetrieves general information about a category. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResourcecategoryId (integer)
Content-Type (string) required
Accept (string) required
includeTreePath (boolean)
catalog/put_api_catalog_pvt_category_by_category_idUpdates a previously existing category. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | ---categoryId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Name (string)
. Keywords (string)
. Title (string)
. Description (string)
. AdWordsRemarketingCode (string)
. LomadeeCampaignCode (string)
. FatherCategoryId (integer)
. GlobalCategoryId (integer)
. ShowInStoreFront (boolean)
. IsActive (boolean)
. ActiveStoreFrontLink (boolean)
. ShowBrandFilter (boolean)
. Score (integer)
. StockKeepingUnitSelectionMode (string)
} (object) required
catalog/post_api_catalog_pvt_categoryCreates a new category. If there is a need to create a new category with a specific custom ID, specify the Id integer in the request. Otherwise, VTEX will generate the ID automatically. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. OContent-Type (string) required
Accept (string) required
data: {
. Id (integer)
. Name (string)
. Keywords (string)
. Title (string)
. Description (string)
. AdWordsRemarketingCode (string)
. LomadeeCampaignCode (string)
. FatherCategoryId (integer)
. GlobalCategoryId (integer)
. ShowInStoreFront (boolean)
. IsActive (boolean)
. ActiveStoreFrontLink (boolean)
. ShowBrandFilter (boolean)
. Score (integer)
. StockKeepingUnitSelectionMode (string)
} (object) required
catalog/get_api_catalog_pvt_product_by_product_id_similarcategoryRetrieves similar categories from a product. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource |productId (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_product_by_product_id_similarcategory_by_category_idAdds a similar category to a product. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -----productId (integer)
categoryId (integer)
Content-Type (string) required
Accept (string) required
catalog/delete_api_catalog_pvt_product_by_product_id_similarcategory_by_category_idDeletes a similar category from a product. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | |productId (integer)
categoryId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_system_pub_specification_field_list_by_category_id_by_category_idRetrieves all specifications from a category by its ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | RcategoryId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_system_pub_specification_field_list_tree_by_category_id_by_category_idLists all specifications including the current category and the level zero specifications from a category by its ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the appliccategoryId (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_subcollection_by_sub_collection_id_category⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections configured through the Legacy CMS Portalhttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L. Associates a single category to a Subcollection, which is a Grouphttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L group-types within a Collection. Permissions Any user or API keysubCollectionId (integer)
Content-Type (string) required
Accept (string) required
data: {
. CategoryId (integer)
} (object) required
catalog/delete_api_catalog_pvt_subcollection_by_sub_collection_id_category_by_category_id⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections configured through the Legacy CMS Portalhttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L. Deletes a category from a subcollection, which is a Grouphttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L group-types within a Collection. Permissions Any user or API keyhttps://subCollectionId (integer)
categoryId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_system_pvt_brand_listRetrieves all brands registered in the store's Catalog. ⚠️ This route's response is limited to 20k results. If you need to obtain more results, please use the Get paginated brand listhttps://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-brand-list endpoint instead to get a paginated response. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://hContent-Type (string) required
Accept (string) required
catalog/get_api_catalog_system_pvt_brand_pagedlistRetrieves all brands registered in the store's Catalog by page number. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | ProductContent-Type (string) required
Accept (string) required
pageSize (integer) required
page (integer) required
catalog/get_api_catalog_system_pvt_brand_by_brand_idRetrieves a specific brand by its ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -----brandId (string)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_brandCreates a new brand. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --------------- | ----Content-Type (string) required
Accept (string) required
data: {
. Id (integer)
. Name (string)
. Text (string)
. Keywords (string)
. SiteTitle (string)
. AdWordsRemarketingCode (string)
. LomadeeCampaignCode (string)
. Score (integer)
. MenuHome (boolean)
. Active (boolean)
. LinkId (string)
} (object) required
catalog/get_api_catalog_pvt_brand_by_brand_idRetrieves information about a specific brand and its context. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategobrandId (string)
Content-Type (string) required
Accept (string) required
catalog/put_api_catalog_pvt_brand_by_brand_idUpdates a previously existing brand. ❗ Although some fields are not required to get a response 200 OK, if you don't send a field or send its value as empty or null, all previously configured information will be deleted, and boolean fields will turn to false. So, to update a product, you should get its data using the Get brand by IDhttps://developers.vtex.com/docs/api-reference/catalog-api get-/api/catalog_system/pvt/brand/-brandId- endpoint and use it as a template for the current request bodbrandId (string)
Content-Type (string) required
Accept (string) required
data: {
. Id (integer)
. Name (string)
. Text (string)
. Keywords (string)
. SiteTitle (string)
. AdWordsRemarketingCode (string)
. LomadeeCampaignCode (string)
. Score (integer)
. MenuHome (boolean)
. Active (boolean)
. LinkId (string)
} (object) required
catalog/delete_api_catalog_pvt_brand_by_brand_idDeletes an existing brand. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | ---------------brandId (string)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_subcollection_by_sub_collection_id_brand⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections configured through the Legacy CMS Portalhttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L. Associates a single brand to a Subcollection, which is a Grouphttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L group-types within a Collection. Permissions Any user or API keyhttsubCollectionId (integer)
Content-Type (string) required
Accept (string) required
data: {
. BrandId (integer)
} (object) required
catalog/delete_api_catalog_pvt_subcollection_by_sub_collection_id_brand_by_brand_id⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections configured through the Legacy CMS Portalhttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L. Deletes a brand from a Subcollection, which is a Grouphttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L group-types within a Collection. Permissions Any user or API keyhttps://devesubCollectionId (integer)
brandId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_pvt_attachment_by_attachmentidGets information about a registered attachment. ⚠️ To understand the specific syntax for Assembly Options attachments, read the Assembly Optionshttps://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH assembly-options-syntax documentation. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resourceattachmentid (string)
Content-Type (string) required
Accept (string) required
catalog/put_api_catalog_pvt_attachment_by_attachmentidUpdates a previously existing SKU attachment with new information. ⚠️ To understand the specific syntax for Assembly Options attachments, read the Assembly Optionshttps://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH assembly-options-syntax documentation. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/licenattachmentid (string)
Content-Type (string) required
Accept (string) required
data: {
. Name (string)
. IsRequired (boolean)
. IsActive (boolean)
. Domains (array)
} (object) required
catalog/delete_api_catalog_pvt_attachment_by_attachmentidDeletes a previously existing SKU attachment. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource |attachmentid (string)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_attachmentCreates a new SKU attachment. ⚠️ To understand the specific syntax for Assembly Options attachments, read the Assembly Optionshttps://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH assembly-options-syntax documentation. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdContent-Type (string) required
Accept (string) required
data: {
. Name (string)
. IsRequired (boolean)
. IsActive (boolean)
. Domains (array)
} (object) required
catalog/get_api_catalog_pvt_attachmentsRetrieves information about all registered attachments. ⚠️ To understand the specific syntax for Assembly Options attachments, read the Assembly Optionshttps://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH assembly-options-syntax documentation. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_pvt_collection_inactiveRetrieves a list of Collection IDs of the inactive collections. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CateContent-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_collectionCreates a new collection. ⚠️ This endpoint is compatible with collections configured through the Legacy CMS Portalhttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run thisContent-Type (string) required
Accept (string) required
data: {
. Name (string)
. Description (string)
. Searchable (boolean)
. Highlight (boolean)
. DateFrom (string)
. DateTo (string)
} (object) required
catalog/get_api_catalog_pvt_collection_stockkeepingunit_importfileexampleImports a sample of the imported XLS file. You need to save the response file to your device. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for thisNo parameters
catalog/post_api_catalog_pvt_collection_by_collection_id_stockkeepingunit_importinsertAdds products to a collection from the request body file. The file must be an imported template. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for tcollectionId (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_collection_by_collection_id_stockkeepingunit_importexcludeRemoves products from a collection from the request body file. The file must be an imported template. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resourcescollectionId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_pvt_collection_by_collection_id_productsRetrieves information about the products from a collection. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategorycollectionId (integer)
Content-Type (string) required
Accept (string) required
page (integer)
pageSize (integer)
Filter (string)
Active (boolean)
Visible (boolean)
CategoryId (integer)
BrandId (integer)
SupplierId (integer)
SalesChannelId (integer)
ReleaseFrom (string)
ReleaseTo (string)
SpecificationProduct (string)
SpecificationFieldId (integer)
catalog/get_api_catalog_pvt_collection_by_collection_id⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections configured through the Legacy CMS Portalhttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L. Retrieves general information of a Collection. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager rcollectionId (integer)
Content-Type (string) required
Accept (string) required
catalog/put_api_catalog_pvt_collection_by_collection_id⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections configured through the Legacy CMS Portalhttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L. Updates a previously created Collection. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourccollectionId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Name (string)
. Searchable (boolean)
. Highlight (boolean)
. DateFrom (string)
. DateTo (string)
} (object) required
catalog/delete_api_catalog_pvt_collection_by_collection_id⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections configured through the Legacy CMS Portalhttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L. Deletes a previously existing Collection. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourcollectionId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_pvt_collection_by_collection_id_subcollection⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections configured through the Legacy CMS Portalhttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L. Retrieves all subcollections given a collection ID. A subcollection is a Grouphttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L group-types within a collection. Permissions Any usecollectionId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_pvt_subcollection_by_sub_collection_id⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections configured through the Legacy CMS Portalhttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L. Retrieves information about a subcollection, which is a Grouphttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L group-types within a collection. Permissions Any user or API keyhttpssubCollectionId (integer)
Content-Type (string) required
Accept (string) required
catalog/put_api_catalog_pvt_subcollection_by_sub_collection_id⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections configured through the Legacy CMS Portalhttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L. Updates a previously created subcollection, which is a Grouphttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L group-types within a collection. Permissions Any user or API keyhttps:subCollectionId (integer)
Content-Type (string) required
Accept (string) required
data: {
. CollectionId (integer)
. Name (string)
. Type (string)
. PreSale (boolean)
. Release (boolean)
} (object) required
catalog/delete_api_catalog_pvt_subcollection_by_sub_collection_id⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections configured through the Legacy CMS Portalhttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L. Deletes a previously created subcollection, which is a Grouphttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L group-types within a collection. Permissions Any user or API keyhttps:subCollectionId (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_subcollection⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections configured through the Legacy CMS Portalhttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L. Creates a new subcollection, which is a Grouphttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L group-types within a collection. A subcollection can be either “Exclusive” all the products coContent-Type (string) required
Accept (string) required
data: {
. CollectionId (integer)
. Name (string)
. Type (string)
. PreSale (boolean)
. Release (boolean)
} (object) required
catalog/post_api_catalog_pvt_collection_by_collection_id_position⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with collections configured through the Legacy CMS Portalhttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L. Edits the position of an SKU that already exists in the subcollection, which is a Grouphttps://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L group-types within a collection. PermissionscollectionId (integer)
Content-Type (string) required
Accept (string) required
data: {
. skuId (integer)
. position (integer)
. subCollectionId (integer)
} (object) required
catalog/get_api_catalog_pvt_subcollection_by_sub_collection_id_specificationvalueRetrieves specification values searching by subcollection ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategosubCollectionId (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_subcollection_by_sub_collection_id_specificationvalueUses a specification value in a subcollection searching by subcollection ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | PsubCollectionId (integer)
Content-Type (string) required
Accept (string) required
data: {
. SubCollectionId (integer)
. SpecificationValueId (integer)
} (object) required
catalog/delete_api_catalog_pvt_subcollection_by_sub_collection_id_specificationvalueDeletes a specification value from a subcollection searching by subcollection ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:subCollectionId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_pvt_specification_by_specification_idRetrieves information of a product or SKU specification. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category |specificationId (integer)
Content-Type (string) required
Accept (string) required
catalog/put_api_catalog_pvt_specification_by_specification_idUpdates a product specification or SKU specification. ⚠️ It is not possible to edit FieldTypeId, CategoryId, FieldGroupId or IsStockKeepingUnit in this API call. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receispecificationId (integer)
Content-Type (string) required
Accept (string) required
data: {
. FieldTypeId (integer)
. CategoryId (integer)
. FieldGroupId (integer)
. Name (string)
. Description (string)
. Position (integer)
. IsFilter (boolean)
. IsRequired (boolean)
. IsOnProductDetails (boolean)
. IsStockKeepingUnit (boolean)
. IsWizard (boolean)
. IsActive (boolean)
. IsTopMenuLinkActive (boolean)
. IsSideMenuLinkActive (boolean)
. DefaultValue (string)
} (object) required
catalog/post_api_catalog_pvt_specificationCreates a new product or SKU specification. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | |Content-Type (string) required
Accept (string) required
data: {
. FieldTypeId (integer)
. CategoryId (integer)
. FieldGroupId (integer)
. Name (string)
. Description (string)
. Position (integer)
. IsFilter (boolean)
. IsRequired (boolean)
. IsOnProductDetails (boolean)
. IsStockKeepingUnit (boolean)
. IsWizard (boolean)
. IsActive (boolean)
. IsTopMenuLinkActive (boolean)
. IsSideMenuLinkActive (boolean)
. DefaultValue (string)
} (object) required
catalog/get_api_catalog_system_pub_specification_field_get_by_field_idRetrieves details from a specification field by this field's ID. ⚠️ This is a legacy endpoint. We recommend using Get specificationhttps://developers.vtex.com/vtex-rest-api/reference/get_api-catalog-pvt-specification-specificationid instead. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6fieldId (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_system_pvt_specification_fieldCreates a specification field in a category. ⚠️ This is a legacy endpoint. We recommend using Create specificationhttps://developers.vtex.com/docs/api-reference/catalog-api post-/api/catalog/pvt/specification?endpoint=post-/api/catalog/pvt/specification instead. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resoContent-Type (string) required
Accept (string) required
data: {
. Name (string)
. CategoryId (integer)
. FieldId (integer)
. IsActive (boolean)
. IsRequired (boolean)
. FieldTypeId (integer)
. FieldValueId (integer)
. Description (string)
. IsStockKeepingUnit (boolean)
. IsFilter (boolean)
. IsOnProductDetails (boolean)
. Position (integer)
. IsWizard (boolean)
. IsTopMenuLinkActive (boolean)
. IsSideMenuLinkActive (boolean)
. DefaultValue (string)
. FieldGroupId (integer)
. FieldGroupName (string)
} (object) required
catalog/put_api_catalog_system_pvt_specification_fieldUpdates a specification field in a category. ⚠️ This is a legacy endpoint. We recommend using Update specificationhttps://developers.vtex.com/docs/api-reference/catalog-api put-/api/catalog/pvt/stockkeepingunit/-skuId-/specification?endpoint=put-/api/catalog/pvt/stockkeepingunit/-skuId-/specification instead. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps:Content-Type (string) required
Accept (string) required
data: {
. Name (string)
. CategoryId (integer)
. FieldId (integer)
. IsActive (boolean)
. IsRequired (boolean)
. FieldTypeId (integer)
. FieldValueId (integer)
. Description (string)
. IsStockKeepingUnit (boolean)
. IsFilter (boolean)
. IsOnProductDetails (boolean)
. Position (integer)
. IsWizard (boolean)
. IsTopMenuLinkActive (boolean)
. IsSideMenuLinkActive (boolean)
. DefaultValue (string)
. FieldGroupId (integer)
. FieldGroupName (string)
} (object) required
catalog/get_api_catalog_system_pvt_specification_field_value_by_field_value_idRetrieves details from a specification field's value by this value's ID. ⚠️ This is a legacy endpoint. We recommend using Get specification valuehttps://developers.vtex.com/docs/api-reference/catalog-api get-/api/catalog/pvt/specificationvalue/-specificationValueId-?endpoint=get-/api/catalog/pvt/specificationvalue/-specificationValueId- instead. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropfieldValueId (string)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_system_pub_specification_fieldvalue_by_field_idGets a list of all specification values from a specification field by this field's ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoifieldId (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_system_pvt_specification_field_valueCreates a specification field value by the specification field's ID. ⚠️ This is a legacy endpoint. We recommend using Create specification valuehttps://developers.vtex.com/docs/api-reference/catalog-api post-/api/catalog/pvt/specificationvalue instead. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6Content-Type (string) required
Accept (string) required
data: {
. FieldId (integer)
. Name (string)
. Text (string)
. IsActive (boolean)
. Position (integer)
} (object) required
catalog/put_api_catalog_system_pvt_specification_field_valueUpdates a specification field value by the specification field's ID. ⚠️ This is a legacy endpoint. We recommend using Update specification field valuehttps://developers.vtex.com/docs/api-reference/catalog-api put-/api/catalog/pvt/stockkeepingunit/-skuId-/specification?endpoint=put-/api/catalog/pvt/stockkeepingunit/-skuId-/specification-value-id instead. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of thContent-Type (string) required
Accept (string) required
data: {
. FieldId (integer)
. Name (string)
. Text (string)
. IsActive (boolean)
. Position (integer)
} (object) required
catalog/get_api_catalog_pvt_specificationvalue_by_specification_value_idRetrieves general information about a specification value. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategoryspecificationValueId (integer)
Content-Type (string) required
Accept (string) required
catalog/put_api_catalog_pvt_specificationvalue_by_specification_value_idUpdates a new specification value for a category. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResourcspecificationValueId (integer)
Content-Type (string) required
Accept (string) required
data: {
. FieldId (integer)
. Name (string)
. Text (string)
. IsActive (boolean)
. Position (integer)
} (object) required
catalog/post_api_catalog_pvt_specificationvalueCreates a new specification value for a category. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResourcContent-Type (string) required
Accept (string) required
data: {
. FieldId (integer)
. Name (string)
. Text (string)
. IsActive (boolean)
. Position (integer)
} (object) required
catalog/get_api_catalog_system_pvt_specification_groupbycategory_by_category_idRetrieves a list of specification groups by the category ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategorcategoryId (string)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_system_pub_specification_group_get_by_group_idRetrieves details from a specification group by the ID of the group. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product |groupId (string)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_specificationgroupCreate a specification group. ⚠️ It is also possible to create a specification Group by using an alternative legacy route: /api/catalog_system/pvt/specification/group. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they willContent-Type (string) required
Accept (string) required
data: {
. CategoryId (integer)
. Name (string)
} (object) required
catalog/put_api_catalog_pvt_specificationgroup_by_group_idUpdate a specification group. ⚠️ It is also possible to update a specification Group by using an alternative legacy route: /api/catalog_system/pvt/specification/group. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they willgroupId (integer)
Content-Type (string) required
Accept (string) required
data: {
. CategoryId (integer)
. Id (integer)
. Name (string)
. Position (integer)
} (object) required
catalog/get_api_catalog_pvt_specification_nonstructured_by_idRetrieves general information about unmapped specifications of a seller's SKU in a Marketplace. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for thId (integer)
Content-Type (string) required
Accept (string) required
catalog/delete_api_catalog_pvt_specification_nonstructured_by_idDeletes unmapped specifications of a seller'S SKU in a marketplace by its unique ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpointId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_pvt_specification_nonstructuredGets general information about unmapped specifications of a seller's SKU in a marketplace by SKU ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources fContent-Type (string) required
Accept (string) required
skuId (integer) required
catalog/delete_api_catalog_pvt_specification_nonstructuredDeletes unmapped specifications of a seller'S SKU in a marketplace by SKU ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: |Content-Type (string) required
Accept (string) required
skuId (integer) required
catalog/get_api_catalog_system_pvt_saleschannel_listRetrieves a list with details about the store's sales channels. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CateContent-Type (string) required
Accept (string) required
catalog/get_api_catalog_system_pub_saleschannel_by_sales_channel_idRetrieves a specific sales channel by its ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource |salesChannelId (string)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_system_pvt_seller_listRetrieves the seller's details by its ID. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
sc (integer)
sellerType (integer)
isBetterScope (boolean)
catalog/get_api_catalog_system_pvt_seller_by_seller_idRetrieves the seller details by its ID. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.sellerId (string)
Content-Type (string) required
Accept (string) required
catalog/put_api_catalog_system_pvt_sellerUpdates a seller. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
data: {
. SellerId (string)
. Name (string)
. Email (string)
. Description (string)
. ExchangeReturnPolicy (string)
. DeliveryPolicy (string)
. UseHybridPaymentOptions (boolean)
. UserName (string)
. Password (string)
. SecutityPrivacyPolicy (string)
. CNPJ (string)
. CSCIdentification (string)
. ArchiveId (integer)
. UrlLogo (string)
. ProductCommissionPercentage (number)
. FreightCommissionPercentage (number)
. CategoryCommissionPercentage (string)
. FulfillmentEndpoint (string)
. CatalogSystemEndpoint (string)
. IsActive (boolean)
. MerchantName (string)
. FulfillmentSellerId (integer)
. SellerType (integer)
. IsBetterScope (boolean)
. TrustPolicy (string)
} (object) required
catalog/post_api_catalog_system_pvt_sellerCreates a new seller. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
data: {
. SellerId (string)
. Name (string)
. Email (string)
. Description (string)
. ExchangeReturnPolicy (string)
. DeliveryPolicy (string)
. UseHybridPaymentOptions (boolean)
. UserName (string)
. Password (string)
. SecutityPrivacyPolicy (string)
. CNPJ (string)
. CSCIdentification (string)
. ArchiveId (integer)
. UrlLogo (string)
. ProductCommissionPercentage (number)
. FreightCommissionPercentage (number)
. CategoryCommissionPercentage (string)
. FulfillmentEndpoint (string)
. CatalogSystemEndpoint (string)
. IsActive (boolean)
. MerchantName (string)
. FulfillmentSellerId (integer)
. SellerType (integer)
. IsBetterScope (boolean)
. TrustPolicy (string)
} (object) required
catalog/get_api_catalog_system_pvt_sellers_by_seller_idRetrieves the seller's details by its ID. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.sellerId (string)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_supplierCreates a new supplier. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --------------- | -Content-Type (string) required
Accept (string) required
data: {
. Name (string)
. CorporateName (string)
. StateInscription (string)
. Cnpj (string)
. Phone (string)
. CellPhone (string)
. CorportePhone (string)
. Email (string)
. IsActive (boolean)
} (object) required
catalog/put_api_catalog_pvt_supplier_by_supplier_idUpdates general information of an existing supplier. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResosupplierId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Name (string)
. CorporateName (string)
. StateInscription (string)
. Cnpj (string)
. Phone (string)
. CellPhone (string)
. CorportePhone (string)
. Email (string)
. IsActive (boolean)
} (object) required
catalog/delete_api_catalog_pvt_supplier_by_supplier_idDeletes an existing supplier. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -------------supplierId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_pvt_product_by_product_id_salespolicyRetrieves a list of the sales channels associated with a product by its ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | PrproductId (integer)
Content-Type (string) required
Accept (string) required
catalog/post_api_catalog_pvt_product_by_product_id_salespolicy_by_tradepolicy_idAssociates an existing sales channel with a product. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResoproductId (integer)
tradepolicyId (integer)
Content-Type (string) required
Accept (string) required
catalog/delete_api_catalog_pvt_product_by_product_id_salespolicy_by_tradepolicy_idDisassociates a sales channel from a product. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource |productId (integer)
tradepolicyId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_system_pvt_sku_stockkeepingunitidsbysaleschannelRetrieves a list of SKU IDs of a sales channel. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResourceContent-Type (string) required
Accept (string) required
sc (integer) required
page (integer)
pageSize (integer)
onlyAssigned (boolean)
catalog/get_api_catalog_system_pvt_products_get_indexed_info_by_product_idRetrieves product indexed data in XML format searching by product ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | ProductproductId (string)
Content-Type (string) required
catalog/get_api_catalog_system_pvt_commercialcondition_listLists all commercial conditions on the store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource |Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_system_pvt_commercialcondition_by_commercial_condition_idRetrieves information of a commercial condition by its ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategorycommercialConditionId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_addon_pvt_giftlist_get_by_list_idRetrieves information about a gift list by its ID. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.listId (integer)
Content-Type (string) required
Accept (string) required
catalog/get_api_catalog_pvt_product_by_product_id_languageRetrieves language-specific information for a product and its associated entities, including categories, brand information, and specifications. Only fields and entities that have valid translations in the requested language are returned. To get translations for a given language, you can filter results using the locale query parameter. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. PermissproductId (integer)
Content-Type (string) required
Accept (string) required
locale (string)
catalog/put_api_catalog_pvt_product_by_product_id_languageInserts or updates language-specific information for a product by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6eukproductId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Locale (string)
. Name (string)
. Title (string)
. Description (string)
. MetaTagDescription (string)
. DescriptionShort (string)
. Keywords (string)
. LinkId (string)
} (object) required
catalog/get_api_catalog_pvt_products_by_product_id_specification_by_specification_id_languageRetrieves language-specific information for a product specification searching by product ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3qproductId (integer)
specificationId (integer)
Content-Type (string) required
Accept (string) required
locale (string)
catalog/put_api_catalog_pvt_products_by_product_id_specification_by_specification_id_languageInserts or updates language-specific information for a given product specification searching by product ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manageproductId (integer)
specificationId (integer)
Content-Type (string) required
Accept (string) required
data: {
. ProductId (integer)
. SpecificationId (integer)
. Locale (string)
. Name (string)
. Value (string)
. Values (array)
} (object) required
catalog/get_api_catalog_pvt_stockkeepingunit_by_sku_id_languageRetrieves language-specific information for a SKU by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be ableskuId (integer)
Content-Type (string) required
Accept (string) required
locale (string)
catalog/put_api_catalog_pvt_stockkeepingunit_by_sku_id_languageInserts or updates language-specific information for a SKU by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 toskuId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Locale (string)
. Name (string)
. MeasurementUnit (string)
} (object) required
catalog/get_api_catalog_pvt_stockkeepingunit_by_sku_id_attribute_by_sku_attribute_id_languageRetrieves language-specific information for a SKU attribute searching by SKU ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6skuId (integer)
skuAttributeId (integer)
Content-Type (string) required
Accept (string) required
locale (string)
catalog/put_api_catalog_pvt_stockkeepingunit_by_sku_id_attribute_by_sku_attribute_id_languageInserts or updates language-specific information for a SKU attribute searching by SKU ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztskuId (integer)
skuAttributeId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Id (integer)
. Locale (string)
. AttributeName (string)
. AttributeValue (string)
} (object) required
catalog/get_api_catalog_pvt_stockkeepingunit_by_sku_id_file_by_sku_file_id_languageRetrieves language-specific information for a SKU file searching by SKU ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6eskuId (integer)
skuFileId (integer)
Content-Type (string) required
Accept (string) required
locale (string)
catalog/put_api_catalog_pvt_stockkeepingunit_by_sku_id_file_by_sku_file_id_languageInserts or updates language-specific information for a SKU file searching by SKU ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YyskuId (integer)
skuFileId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Locale (string)
. Label (string)
. Name (string)
. Text (string)
} (object) required
catalog/get_api_catalog_pvt_specificationgroup_by_specification_group_id_languageRetrieves language-specific information for a specification group by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6specificationGroupId (integer)
Content-Type (string) required
Accept (string) required
locale (string)
catalog/put_api_catalog_pvt_specificationgroup_by_specification_group_id_languageInserts or updates language-specific information for a specification group by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YspecificationGroupId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Locale (string)
. Name (string)
} (object) required
catalog/get_api_catalog_pvt_specification_by_specification_id_languageRetrieves language-specific information for a specification by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 tspecificationId (integer)
Content-Type (string) required
Accept (string) required
locale (string)
catalog/put_api_catalog_pvt_specification_by_specification_id_languageInserts or updates language-specific information for a specification by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rspecificationId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Locale (string)
. Name (string)
. Description (string)
} (object) required
catalog/get_api_catalog_pvt_specificationvalue_by_value_id_languageRetrieves language-specific information for a specification value by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6valueId (integer)
Content-Type (string) required
Accept (string) required
locale (string)
catalog/put_api_catalog_pvt_specificationvalue_by_value_id_languageInserts or updates language-specific information for a specification value by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YvalueId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Locale (string)
. Name (string)
} (object) required
catalog/get_api_catalog_pvt_category_by_category_id_languageRetrieves language-specific information for a given category. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be ablecategoryId (integer)
Content-Type (string) required
Accept (string) required
locale (string)
catalog/put_api_catalog_pvt_category_by_category_id_languageInserts or updates language-specific information for a category by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6eucategoryId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Locale (string)
. Name (string)
. Title (string)
. Description (string)
. Keywords (string)
. LinkId (string)
} (object) required
catalog/get_api_catalog_pvt_brand_by_brand_id_languageRetrieves language-specific information for a brand by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be ablbrandId (integer)
Content-Type (string) required
Accept (string) required
locale (string)
catalog/put_api_catalog_pvt_brand_by_brand_id_languageInserts or updates language-specific information for a brand by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3brandId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Locale (string)
. Name (string)
. Text (string)
. Keywords (string)
. SiteTitle (string)
. LinkId (string)
} (object) required
catalog/get_api_catalog_pvt_attachment_by_attachment_id_languageRetrieves language-specific information for an attachment by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 toattachmentId (integer)
Content-Type (string) required
Accept (string) required
locale (string)
catalog/put_api_catalog_pvt_attachment_by_attachment_id_languageInserts or updates language-specific information for an attachment by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdcattachmentId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Locale (string)
. Name (string)
} (object) required
catalog/get_api_catalog_pvt_skuservicetype_by_sku_service_type_id_languageRetrieves language-specific information for a SKU service type by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6eukskuServiceTypeId (integer)
Content-Type (string) required
Accept (string) required
locale (string)
catalog/put_api_catalog_pvt_skuservicetype_by_sku_service_type_id_languageInserts or updates language-specific information for a SKU service type by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQskuServiceTypeId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Locale (string)
. Name (string)
} (object) required
catalog/get_api_catalog_pvt_skuservice_by_skuservice_id_languageRetrieves language-specific information for a given SKU service by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euskuserviceId (integer)
Content-Type (string) required
Accept (string) required
locale (string)
catalog/put_api_catalog_pvt_skuservice_by_skuservice_id_languageInserts or updates language-specific information for a SKU service by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdcskuserviceId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Locale (string)
. Name (string)
. Text (string)
} (object) required
catalog/get_api_catalog_pvt_skuservicevalue_by_sku_service_value_id_languageRetrieves language-specific information for a SKU service value by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euskuServiceValueId (integer)
Content-Type (string) required
Accept (string) required
locale (string)
catalog/put_api_catalog_pvt_skuservicevalue_by_sku_service_value_id_languageInserts or updates language-specific information for a SKU service value by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynskuServiceValueId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Locale (string)
. Name (string)
} (object) required
catalog/get_api_catalog_pvt_collection_by_collection_id_languageRetrieves language-specific information for a collection by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to bcollectionId (integer)
Content-Type (string) required
Accept (string) required
locale (string)
catalog/put_api_catalog_pvt_collection_by_collection_id_languageInserts or updates language-specific information for a collection by its ID. ℹ️ Learn more in the Catalog multi-language integration guidehttps://developers.vtex.com/docs/guides/catalog-multi-language-integration-guide. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6collectionId (integer)
Content-Type (string) required
Accept (string) required
data: {
. Locale (string)
. Name (string)
. Description (string)
. LinkId (string)
} (object) required
catalog/post_api_catalog_pvt_assortmentCreates a new product assortment at the merchant level. The name field must be unique across the merchant's assortments. The assortment is created empty, without included or excluded collections, which can later be added through the Add included collection to product assortmenthttps://developers.vtex.com/docs/api-reference/assortments-api post-/api/catalog/pvt/assortment/-productAssortmentID-/included-collections/-collectionID- and Add excluded collection to product assortmenthttps://developeContent-Type (string) required
Accept (string) required
data: {
. name (string)
} (object) required
catalog/get_api_catalog_pvt_assortmentRetrieves the list of product assortments registered at the merchant level. Assortments are used to segment the catalog for specific business contexts for example, B2B contracts or Organization Units based on the inclusion and exclusion of collection IDs: - Inclusion model: All products are restricted by default, and only SKUs that belong to the included collections are visible. - Exclusion model: All products are available by default, and SKUs that belong to the excluded collections areAccept (string) required
name (string)
after (integer)
size (integer)
collectionId (integer)
catalog/get_api_catalog_pvt_assortment_by_product_assortment_idRetrieves the details of a product assortment given its unique identifier, including the list of included and excluded collections. ⚠️ This feature is only available for stores using the B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3productAssortmentID (integer)
Accept (string) required
catalog/put_api_catalog_pvt_assortment_by_product_assortment_idUpdates the name of an existing product assortment given its unique identifier. The new name must be unique across the merchant's assortments. ⚠️ This feature is only available for stores using the B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-rproductAssortmentID (integer)
Content-Type (string) required
Accept (string) required
data: {
. name (string)
} (object) required
catalog/delete_api_catalog_pvt_assortment_by_product_assortment_idDeletes a product assortment given its unique identifier. ❗ Deleting an assortment does not automatically remove its reference from contracts or Organizational Unit scopes assortmentIds. Make sure to remove those references before or after deletion to avoid orphaned references. ⚠️ This feature is only available for stores using the B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authenticproductAssortmentID (integer)
Accept (string) required
catalog/post_api_catalog_pvt_assortment_by_product_assortment_id_included_collections_by_collection_idAssociates a collection as an included collection of the specified product assortment. Included collections define the SKUs that must be explicitly allowed when the inclusion model is applied to the catalog segmentation. The same collection cannot be associated twice with the same assortment. In that case, the request will return a status code 409 error. ⚠️ This feature is only available for stores using the B2B Buyer Portal, which is currently available to select accounts. PermissioproductAssortmentID (integer)
collectionID (integer)
Accept (string) required
catalog/delete_api_catalog_pvt_assortment_by_product_assortment_id_included_collections_by_collection_idRemoves a collection from the included collections list of the specified product assortment. ⚠️ This feature is only available for stores using the B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to sucproductAssortmentID (integer)
collectionID (integer)
Accept (string) required
catalog/post_api_catalog_pvt_assortment_by_product_assortment_id_excluded_collections_by_collection_idAssociates a collection as an excluded collection of the specified product assortment. Excluded collections define the SKUs that must be hidden when the exclusion model is applied to the catalog segmentation. The same collection cannot be associated twice with the same assortment. In that case, the request will return a status code 409 error. ⚠️ This feature is only available for stores using the B2B Buyer Portal, which is currently available to select accounts. Permissions Any usproductAssortmentID (integer)
collectionID (integer)
Accept (string) required
catalog/delete_api_catalog_pvt_assortment_by_product_assortment_id_excluded_collections_by_collection_idRemoves a collection from the excluded collections list of the specified product assortment. ⚠️ This feature is only available for stores using the B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to sucproductAssortmentID (integer)
collectionID (integer)
Accept (string) required
catalog/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
checkout/post_api_checkout_pub_order_forms_simulationThis endpoint is used to simulate a cart in VTEX Checkout. It receives an SKU ID, the quantity of items in the cart and the seller ID. It returns all information about the cart, such as the selling price of each item, pricing and promotion data, payment and logistics info. This request is useful whenever you need to know the availability of fulfilling an order for a specific cart setting, since the API response will let you know the updated price, inventory and shipping data. ⚠️ TheContent-Type (string) required
Accept (string) required
RnbBehavior (integer)
sc (integer)
individualShippingEstimates (boolean)
data: {
. items (array)
. country (string)
. postalCode (string)
. geoCoordinates (array)
. allowedOutdatedData (array)
} (object) required
checkout/get_api_checkout_pub_order_formYou can use this request to get your current shopping cart information orderFormId or to create a new cart. Important: To create a new empty shopping cart you need to send this request with the query param forceNewCart=true. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId obtained in response is the identification code of the newly created cart.Content-Type (string) required
Accept (string) required
forceNewCart (boolean)
individualShippingEstimates (boolean)
checkout/get_api_checkout_pub_order_form_by_order_form_idRetrieves all information associated to a given shopping cart. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart. This request has a time out of 45 seconds. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the apporderFormId (string)
Content-Type (string) required
Accept (string) required
refreshOutdatedData (boolean)
individualShippingEstimates (boolean)
checkout/post_api_checkout_pub_order_form_by_order_form_id_items_remove_allThis request removes all items from a given cart, leaving it empty. You must send an empty JSON in the body of the request. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart. ℹ️ Request body must always be sent with empty value ' ' in this endpoint. Permissions Any user or API keyhttps://develorderFormId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data (object) required
checkout/get_checkout_change_to_anonymous_user_by_order_form_idThis call removes all user information, making a cart anonymous while leaving the items. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure that represents a shopping cart and contains all information about it. Hence, the orderFormId is the identification code of a given cart. This call works by creating a new orderForm, setting a new cookie, and returning a redirect 302 to the cart URL /checkout/ /orderform. Permissions Any user or API keyorderFormId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
checkout/post_api_checkout_pub_order_form_by_order_form_id_items_updateYou can use this request to: 1. Change the quantity of one or more items in a specific cart. 2. Remove an item from the cart by sending the quantity value = 0 in the request body. ℹ️ To remove all items from the cart at the same time, use the Remove all itemshttps://developers.vtex.com/docs/api-reference/checkout-api post-/api/checkout/pub/orderForm/-orderFormId-/items/removeAll?endpoint=post-/api/checkout/pub/orderForm/-orderFormId-/items/removeAll endpoint. The orderFormhttps://develorderFormId (string)
Content-Type (string) required
Accept (string) required
allowedOutdatedData (array)
individualShippingEstimates (boolean)
data: {
. orderItems (array)
} (object) required
checkout/post_api_checkout_pub_order_form_by_order_form_id_itemsUse this request to add a new item to the shopping cart. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart. This request has a time out of 45 seconds. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriatorderFormId (string)
Content-Type (string) required
Accept (string) required
allowedOutdatedData (array)
individualShippingEstimates (boolean)
data: {
. orderItems (array)
} (object) required
checkout/patch_api_checkout_pub_order_form_by_order_form_id_itemsYou can use this request to: 1. Change the quantity or price of one or more items to the shopping cart. 2. Add a new item to the shopping cart. Important: To add a new item to the shopping cart, do not send the string index in the request body. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure that represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart. ThiorderFormId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. orderItems (array)
} (object) required
checkout/put_api_checkout_pub_order_form_by_order_form_id_items_by_item_index_priceThis request changes the price of an SKU in a cart. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart. You need to inform which cart you are referring to, by sending its orderFormId and what is the item whose price you want to change, by sending its itemIndex. You also need to pass the new price valueorderFormId (string)
itemIndex (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. price (integer)
} (object) required
checkout/delete_api_checkout_pub_order_form_by_order_form_id_items_by_item_index_priceThis request deletes the manual price previously set for an SKU in a cart, reverting the item to its original price. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart. You need to inform which cart you are referring to, by sending its orderFormId, and which item should have its manual price deleted, by seorderFormId (string)
itemIndex (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
checkout/patch_api_checkout_pub_order_form_by_order_form_id_profileWhen a shopper provides an email address at Checkout, the platform tries to retrieve existing profile information for that email and add it to the shopping cart information. Use this request if you want to change this behavior for a given cart, meaning profile information will not be included in the order automatically. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. HenorderFormId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. ignoreProfileData (boolean)
} (object) required
checkout/get_api_checkout_pub_profilesRetrieves a client's profile information by providing an email address. If the response body fields are empty, the following situations may have occurred: 1. There is no client registered with the email address provided in your store, or; 2. Client profile is invalid or incomplete. However, you can use the query parameter ensureComplete=false to get incomplete profiles. For more information, see SmartCheckout - Customer information automatic fill-inhttps://help.vtex.com/en/tutorial/smartcContent-Type (string) required
Accept (string) required
email (string) required
ensureComplete (boolean)
individualShippingEstimates (boolean)
checkout/post_api_checkout_pub_order_form_by_order_form_id_attachments_client_profile_dataUse this request to include client profile information to a given shopping cart. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart. This request has a timeout of 12 seconds. ⚠️ The authentication of this endpoint can change depending on the customer context. If you are modifying information from a custorderFormId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. email (string)
. firstName (string)
. lastName (string)
. documentType (string)
. document (string)
. phone (string)
. corporateName (string)
. tradeName (string)
. corporateDocument (string)
. stateInscription (string)
. corporatePhone (string)
. isCorporate (boolean)
} (object) required
checkout/post_api_checkout_pub_order_form_by_order_form_id_attachments_shipping_dataUse this request to include shipping information and/or selected delivery option to a given shopping cart. To add shipping addresses, send the selectedAddresses array. To select a delivery option, use the logisticsInfo array. The orderFormId identifies the shopping cart. For more information, see orderFormhttps://developers.vtex.com/docs/guides/orderform-fields. This request has a timeout of 12 seconds. ⚠️ If the request modifies a customer with a complete profile, the response willorderFormId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. clearAddressIfPostalCodeNotFound (boolean)
. selectedAddresses (array)
. logisticsInfo (array)
} (object) required
checkout/post_api_checkout_pub_order_form_by_order_form_id_attachments_client_preferences_dataUse this request to include client preferences information to a given shopping cart. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart. This request has a timeout of 12 seconds. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at lorderFormId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. locale (string)
. optinNewsLetter (boolean)
} (object) required
checkout/post_api_checkout_pub_order_form_by_order_form_id_attachments_marketing_dataUse this request to include marketing information to a given shopping cart. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart. This request has a timeout of 12 seconds. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least oneorderFormId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. coupon (string)
. marketingTags (array)
. utmSource (string)
. utmMedium (string)
. utmCampaign (string)
. utmiPage (string)
. utmiPart (string)
. utmiCampaign (string)
} (object) required
checkout/post_api_checkout_pub_order_form_by_order_form_id_attachments_payment_dataUse this request to include payment information to a given shopping cart. The payment information attachment in the shopping cart does not determine the final order payment method in itself. However, it allows tha platform to update any relevant information that may be impacted by the payment method. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormIdorderFormId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. payments (array)
} (object) required
checkout/post_api_checkout_pub_order_form_by_order_form_id_items_by_item_index_attachments_by_attachment_nameUse this request to add an attachment to a specific item in a shopping cart. Attachments allow you to include extra information to a cart item, such as subscription or gift details, according to the attachment schemas available for that item, which can be checked in the attachmentOfferings field of the orderFormhttps://developers.vtex.com/docs/guides/orderform-fields. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart aorderFormId (string)
itemIndex (string)
attachmentName (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. content (object)
} (object) required
checkout/delete_api_checkout_pub_order_form_by_order_form_id_items_by_item_index_attachments_by_attachment_nameUse this request to remove an attachment from a specific item in a shopping cart. Attachments allow you to include extra information to a cart item, such as subscription or gift details, according to the attachment schemas available for that item, which can be checked in the attachmentOfferings field of the orderFormhttps://developers.vtex.com/docs/guides/orderform-fields. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping corderFormId (string)
itemIndex (string)
attachmentName (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
checkout/post_api_checkout_pub_order_form_by_order_form_id_attachments_subscription_dataUse this request to attach subscription information to one or more items in a shopping cart, defining the recurrence plan frequency, validity, and type under which the items will be purchased. The available subscription schemas for each item can be checked in the attachmentOfferings field of the orderFormhttps://developers.vtex.com/docs/guides/orderform-fields. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contorderFormId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. subscriptions (array)
} (object) required
checkout/delete_api_checkout_pub_order_form_by_order_form_id_attachments_subscription_dataUse this request to remove the subscription information attached to the items in a shopping cart. To remove all subscriptions from the cart, send an empty subscriptions array in the request body. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. This means the orderFormId is the identification code of a given cart. This request has a timeout of 12 seconds. PermisorderFormId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. subscriptions (array)
} (object) required
checkout/post_api_checkout_pub_order_form_by_order_form_id_attachments_merchant_context_dataThis endpoint is used for the merchant to add to the cart any relevant information that is related to the context of a specific order. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart. This request has a timeout of 12 seconds. Permissions Any user or API keyhttps://developers.vtex.com/docs/guideorderFormId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. salesAssociateData (object)
} (object) required
checkout/post_api_checkout_pub_order_form_by_order_form_id_attachments_invoice_dataAttaches invoice data to the cart. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart. This request has a timeout of 12 seconds. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourorderFormId (string)
Content-Type (string) required
Accept (string) required
data: {
. address (object)
} (object) required
checkout/put_api_checkout_pub_order_form_by_order_form_id_custom_data_by_app_idYour account may create apps, which contain custom fields, through the Update orderForm configurationhttps://developers.vtex.com/docs/api-reference/checkout-api post-/api/checkout/pvt/configuration/orderForm request. The values of these custom fields can then be updated by this request. To do that, you need to inform the ID of the app you created with the configuration API appId. In the body of the request, for each field created in this app appFieldName you will inform a value appFieldValorderFormId (string)
appId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data (object) required
checkout/put_api_checkout_pub_order_form_by_order_form_id_custom_data_by_app_id_by_app_field_nameYour account may create apps, which contain custom fields, through the Update orderForm configurationhttps://developers.vtex.com/docs/api-reference/checkout-api post-/api/checkout/pvt/configuration/orderForm request. The value of a specific custom field can then be updated by this request. To do that, you need to inform in the URL the ID of the app you created with the configuration API appId. In the body of the request, you will inform the new value appFieldValue, passed through the bodyorderFormId (string)
appId (string)
appFieldName (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. value (string)
} (object) required
checkout/delete_api_checkout_pub_order_form_by_order_form_id_custom_data_by_app_id_by_app_field_nameYour account may create apps, which contain custom fields, through the Update orderForm configurationhttps://developers.vtex.com/docs/api-reference/checkout-api post-/api/checkout/pvt/configuration/orderForm request. The value of a specific custom field can be removed by this request. To do that, you need to inform in the URL the ID of the app you created with the configuration API appId. You also need to iform the specific field created in this app identified by the appFieldName parameterorderFormId (string)
appId (string)
appFieldName (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
checkout/put_api_checkout_pub_order_form_by_order_form_id_custom_fieldsAdd multiple custom fields to an order form in a single request. Custom fields can be linked to the order, specific items, or addresses and be related to different entities from Master Data. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart. ⚠️ This feature is only available for stores using B2B Buyer PortaorderFormId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data (array) required
checkout/put_api_checkout_pub_order_form_by_order_form_id_custom_fields_orderAdd a custom field to the order level of an orderForm. Order-level custom fields are not linked to any specific item or address. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. PermorderFormId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. name (string)
. value (string)
. refId (string)
} (object) required
checkout/put_api_checkout_pub_order_form_by_order_form_id_custom_fields_item_by_item_idAdd a custom field to a specific item in an orderForm. The custom field is linked to the item's unique ID. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user ororderFormId (string)
itemId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. name (string)
. value (string)
. refId (string)
} (object) required
checkout/delete_api_checkout_pub_order_form_by_order_form_id_custom_fields_item_by_item_idRemove a specific custom field from an item in an orderForm. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guideorderFormId (string)
itemId (string)
fieldName (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
checkout/put_api_checkout_pub_order_form_by_order_form_id_custom_fields_address_by_address_idAdd a custom field to a specific address in an orderForm. The custom field is linked to the address ID. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or AorderFormId (string)
addressId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. name (string)
. value (string)
. refId (string)
} (object) required
checkout/get_api_checkout_pvt_configuration_order_formRetrieves the settings that are currently applied to every orderForm in the account. These settings are defined by the request Update orderForm configurationhttps://developers.vtex.com/docs/api-reference/checkout-api post-/api/checkout/pvt/configuration/orderForm. Always use this request to retrieve the current configuration before performing an update. By doing so you ensure that you are modifying only the properties you want. Permissions Any user or API keyhttps://developers.vteContent-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
checkout/post_api_checkout_pvt_configuration_order_formDetermines settings that will apply to every orderForm in the account. For example, if you create an app using this request, every orderForm of this account will have the custom fields created though it. ℹ️ Always retrieve the current configuration before performing an update to ensure that you are modifying only the properties you want. Otherwise, old values can be overwritten. To retrieve the current configuration, use the request Get orderForm configurationhttps://developers.vtex.com/doContent-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. paymentConfiguration
. taxConfiguration (object)
. minimumQuantityAccumulatedForItems (integer)
. decimalDigitsPrecision (integer)
. minimumValueAccumulated (integer)
. apps (array)
. allowMultipleDeliveries (boolean)
. allowManualPrice (boolean)
. maxNumberOfWhiteLabelSellers (integer)
. maskFirstPurchaseData (boolean)
. maskStateOnAddress (boolean)
. recaptchaValidation (string)
. paymentSystemToCheckFirstInstallment (string)
} (object) required
checkout/get_api_checkout_pvt_configuration_window_to_change_sellerRetrieves a marketplace's window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it. The default period for this window is of 2 days, but it can be configured by the request Update window to change seller. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://heContent-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
checkout/post_api_checkout_pvt_configuration_window_to_change_sellerUpdates a marketplace's window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it. It is possible to check the current window using the request Get window to change seller. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-mContent-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. waitingTime (integer)
} (object) required
checkout/post_api_checkout_pub_order_form_by_order_form_id_messages_clearThis request removes all messages from the messages field of the orderForm , leaving it empty. You must send an empty JSON in the body of the request. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart. Important: Request Body must always be sent with empty value ' ' in this endpoint. PermissionsorderFormId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data (object) required
checkout/get_api_checkout_pub_order_form_by_order_form_id_installmentsRetrieves possible amount of installments and respective values for a given cart with a given payment method. The orderFormhttps://developers.vtex.com/docs/guides/orderform-fields is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart. This endpoint can be used to get the installment options for only one payment method at a time. This endpoint should be called only after theorderFormId (string)
paymentSystem (integer) required
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
checkout/post_api_checkout_pub_order_form_by_order_form_id_couponsUse this request to add coupons to a given shopping cart. To add multiple coupons to the same cart, you need to: 1. Request the activation of this feature through the Support VTEXhttps://help.vtex.com/support if this is the first time you perform this action on your store. 2. Submit all coupon codes in the same requisition separated by commas. E.g.: 'text': 'freeshipping, discount10, holiday30'. For more information on multiple coupons, access the coupons tutorialhttps://help.vtex.com/orderFormId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. text (string)
} (object) required
checkout/get_api_checkout_pub_pickup_pointsRetrieves information on pickup points close to a given location determined by geocoordinates or postal code. The pickup points returned are not necessarily all active ones. Make sure to validate the information consumed by integrations. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
geoCoordinates (string)
postalCode (string)
countryCode (string)
individualShippingEstimates (boolean)
checkout/get_api_checkout_pub_postal_code_by_country_code_by_postal_codeRetrieves address information for a given postal code and country. This request can be used to implement auto complete functionality when a customer needs to fill in an address. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.countryCode (string)
postalCode (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
checkout/post_api_checkout_pub_order_form_by_order_form_id_transactionThis endpoint places an order from an existing orderForm object, meaning an existing cart. After the creation of an order with this request, you have five minutes to send payment information and then request payment processing. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to borderFormId (string)
Content-Type (string) required
Accept (string) required
individualShippingEstimates (boolean)
data: {
. referenceId (string)
. savePersonalData (boolean)
. optinNewsLetter (boolean)
. value (integer)
. referenceValue (integer)
. interestValue (integer)
} (object) required
checkout/put_api_checkout_pub_ordersPlaces order without having any prior cart information. This means all information on items, client, payment and shipping must be sent in the body. ⚠️ The authentication of this endpoint is required if you are creating an order with an item that has an attachment that creates a Subscription. For more information, access Subscriptions APIhttps://developers.vtex.com/docs/api-reference/subscriptions-api-v3. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-autheContent-Type (string) required
Accept (string) required
sc (integer)
individualShippingEstimates (boolean)
data: {
. items (array)
. clientProfileData (object)
. shippingData (object)
. paymentData (object)
. marketingData (object)
. openTextField (string)
. salesAssociateData (object)
} (object) required
checkout/post_api_checkout_pub_gateway_callback_by_order_groupOrder processing callback request, which is made after an order's payment is approved. This request has to be made within five minutes after the Place orderhttps://developers.vtex.com/docs/api-reference/checkout-api put-/api/checkout/pub/orders or Place order from existing carthttps://developers.vtex.com/docs/api-reference/checkout-api post-/api/checkout/pub/orderForm/-orderFormId-/transaction request has been made, or else, the order will not be processed. Permissions Any user or AorderGroup (string)
Content-Type (string) required
Accept (string) required
Cookie (string) required
individualShippingEstimates (boolean)
checkout/get_api_checkout_pub_regions_by_region_idRetrieves a list of sellers that cater to a specific region or address, according to your setup of our regionalization featurehttps://help.vtex.com/en/tutorial/setting-up-price-and-availability-of-skus-by-region--12ne58BmvYsYuGsimmugoc . Learn more about Region v2https://developers.vtex.com/docs/guides/region-v2-release. To access the list of sellers, you must choose one of the following methods: 1. Send the identification of the list of sellers regionId as a path parameter through the URLregionId (string)
Content-Type (string) required
Accept (string) required
country (string) required
postalCode (string)
geoCoordinates (array)
individualShippingEstimates (boolean)
checkout/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
checkout_custom_card_payment/post_api_profile_system_pvt_profilesCreates a new Storefront user profile in the Profile System with personal data and addresses. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfContent-Type (string) required
Accept (string) required
data: {
. personalData (object)
. addresses (object)
} (object) required
checkout_custom_card_payment/post_api_card_token_vault_tokensSaves a new card token to the Card Token Vault. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. ℹ️ This endpoint must use the accountAuthCookie value generated from the Validate client loginhttps://developers.vtex.com/docs/api-reference/checkout-custom-card-payment-api post-/api/vtexid/pub/authentication/classic/validate endpoint. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.Content-Type (string) required
Accept (string) required
data: {
. providerId (string)
. card (object)
. cardTokenData (object)
. email (string)
} (object) required
checkout_custom_card_payment/post_api_checkout_pub_order_form_by_order_form_id_itemsAdds items to the orderForm. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. ℹ️ This endpoint must use the accountAuthCookie value generated from the Validate client loginhttps://developers.vtex.com/docs/api-reference/checkout-custom-card-payment-api post-/api/vtexid/pub/authentication/classic/validate endpoint. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/en/tutorial/licorderFormId (string)
Content-Type (string) required
Accept (string) required
data: {
. orderItems (array)
} (object) required
checkout_custom_card_payment/post_api_checkout_pub_order_form_by_order_form_id_attachments_client_profile_dataAttaches client profile data to the orderForm. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. ℹ️ This endpoint must use the accountAuthCookie value generated from the Validate client loginhttps://developers.vtex.com/docs/api-reference/checkout-custom-card-payment-api post-/api/vtexid/pub/authentication/classic/validate endpoint. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.corderFormId (string)
Content-Type (string) required
Accept (string) required
data: {
. email (string)
} (object) required
checkout_custom_card_payment/post_api_vtexid_pub_authentication_startloginInitiates the authentication process for a user. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
checkout_custom_card_payment/post_api_vtexid_pub_authentication_classic_validateValidates user credentials and returns authentication cookies. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
an (string) required
checkout_custom_card_payment/post_api_checkout_pub_order_form_by_order_form_id_attachments_payment_dataAttaches payment information to the orderForm. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3. Storefront permissions The storefront user logged in using endpoint Validate client loginhttps://developers.vtex.com/docs/api-reference/checkout-custom-card-paymenorderFormId (string)
Content-Type (string) required
Accept (string) required
data: {
. payments (array)
} (object) required
checkout_custom_card_payment/post_api_checkout_pub_order_form_by_order_form_id_transactionProcesses the order and creates a transaction. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. ℹ️ This endpoint must use the accountAuthCookie value generated from the Validate client loginhttps://developers.vtex.com/docs/api-reference/checkout-custom-card-payment-api post-/api/vtexid/pub/authentication/classic/validate endpoint. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.corderFormId (string)
Content-Type (string) required
Accept (string) required
data: {
. savePersonalData (boolean)
. optinNewsLetter (boolean)
. value (integer)
. referenceValue (integer)
. interestValue (integer)
} (object) required
checkout_custom_card_payment/get_api_pvt_transactions_by_transaction_idRetrieves detailed information about a specific transaction. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. ℹ️ This endpoint must use the accountAuthCookie value generated from the Validate client loginhttps://developers.vtex.com/docs/api-reference/checkout-custom-card-payment-api post-/api/vtexid/pub/authentication/classic/validate endpoint. Permissions This endpoint does not require License Manager resourceshttpstransactionId (string)
Content-Type (string) required
Accept (string) required
checkout_custom_card_payment/get_api_pvt_transactions_by_transaction_id_paymentsRetrieves a list of payments associated with a transaction. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. ℹ️ This endpoint must use the accountAuthCookie value generated from the Validate client loginhttps://developers.vtex.com/docs/api-reference/checkout-custom-card-payment-api post-/api/vtexid/pub/authentication/classic/validate endpoint. Permissions This endpoint does not require License Manager resourceshttps:transactionId (string)
Content-Type (string) required
Accept (string) required
an (string) required
checkout_custom_card_payment/get_api_pvt_accounts_by_account_idRetrieves card information by account ID. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. ℹ️ This endpoint must use the accountAuthCookie value generated from the Validate client loginhttps://developers.vtex.com/docs/api-reference/checkout-custom-card-payment-api post-/api/vtexid/pub/authentication/classic/validate endpoint. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/enaccountId (string)
Content-Type (string) required
Accept (string) required
checkout_custom_card_payment/get_api_profile_system_pvt_profiles_by_profile_id_vcs_checkoutRetrieves the list of cards associated with a profile. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. ℹ️ This endpoint must use the accountAuthCookie value generated from the Validate client loginhttps://developers.vtex.com/docs/api-reference/checkout-custom-card-payment-api post-/api/vtexid/pub/authentication/classic/validate endpoint. Permissions This endpoint does not require License Manager resourceshttps://helprofileId (string)
Content-Type (string) required
Accept (string) required
checkout_custom_card_payment/delete_api_profile_system_pvt_profiles_by_profile_id_personal_dataDeletes personal data for a specific profile. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. ℹ️ This endpoint must use the accountAuthCookie value generated from the Validate client loginhttps://developers.vtex.com/docs/api-reference/checkout-custom-card-payment-api post-/api/vtexid/pub/authentication/classic/validate endpoint. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.coprofileId (string)
Content-Type (string) required
Accept (string) required
an (string) required
checkout_custom_card_payment/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
custom_fields/get_api_dataentities_custom_field_settings_searchRetrieves the settings of custom fields for a given contract. The response includes field configuration details such as name, type, level, and whether the field is enabled or required. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.Accept (string) required
Content-Type (string) required
_schema (string) required
_fields (string) required
_where (string) required
custom_fields/post_api_dataentities_custom_field_settings_documentsCreates and configures a custom field for a specific contract. You can define the field name, type, level, and whether it is enabled or required. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-reContent-Type (string) required
Accept (string) required
_schema (string) required
data: {
. contractId (string)
. name (string)
. enabled (boolean)
. required (boolean)
. level (string)
. type (string)
. additionalData (string)
} (object) required
custom_fields/patch_api_dataentities_custom_field_settings_documents_by_document_idUpdates the configuration of an existing custom field. This endpoint allows you to enable or disable a custom field, mark it as required, define the level item, order, or address, and set its type text, number, or option. You can also provide optional additionalData for custom validations, allowed values, or integration rules. Each request handles a single custom field configuration. The field is identified by its auto-generated ID. ⚠️ This feature is only available for stores using B2B BuyerdocumentId (string)
Content-Type (string) required
Accept (string) required
_schema (string) required
data: {
. contractId (string)
. name (string)
. enabled (boolean)
. required (boolean)
. level (string)
. type (string)
. additionalData (string)
} (object) required
custom_fields/delete_api_dataentities_custom_field_settings_documents_by_document_idDeletes the custom field settings document associated with the given document ID. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run tdocumentId (string)
Accept (string) required
_schema (string) required
custom_fields/post_api_dataentities_custom_field_values_documentsCreates a value for an existing custom field for a given contract. If you are creating a value for a custom field configured with level address, you must send a valid address ID in the field auxId. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourcesContent-Type (string) required
Accept (string) required
_schema (string) required
data: {
. contractId (string)
. customFieldId (string)
. auxId (string)
. value (string)
. description (string)
} (object) required
custom_fields/get_api_dataentities_custom_field_values_documents_by_custom_field_value_idRetrieves a specific custom field value document by its ID. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. OtherwisecustomFieldValueId (string)
Accept (string) required
_fields (string) required
_schema (string) required
custom_fields/patch_api_dataentities_custom_field_values_documents_by_custom_field_value_idUpdates the value of a specific custom field for a given contract. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. OtcustomFieldValueId (string)
Content-Type (string) required
Accept (string) required
_schema (string) required
data: {
. contractId (string)
. customFieldId (string)
. auxId (string)
. value (string)
. description (string)
} (object) required
custom_fields/delete_api_dataentities_custom_field_values_documents_by_custom_field_value_idDeletes a specific custom field value document. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will rcustomFieldValueId (string)
Accept (string) required
_fields (string) required
_schema (string) required
custom_fields/get_api_dataentities_custom_field_values_searchRetrieves custom field values filtered by contract ID, custom field ID, and optionally by specific value. Results can be sorted by value. You can use the _where query parameter to filter results: - To get all values: _where=contractId=contractId AND customFieldId='customFieldId' - To get a specific value: _where=contractId=contractId AND customFieldId='customFieldId' AND value='value' ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to selAccept (string) required
_schema (string) required
_fields (string) required
_where (string) required
_sort (string)
custom_fields/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
customer_credit/get_api_creditcontrol_invoicesReturns a list of invoices related to payment orders created through customer credit accountshttps://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU. ℹ️ Query parameters can be used individually or combined to filter invoice results. Queries to filter results - By the location of the invoices in the list quantity of invoices: ?from=int and to=int - By creation date: ?createdDateFrom=dateISO8601 and createDateTo=dateISO8601. TheContent-Type (string) required
Accept (string) required
from (string)
to (string)
createdDateFrom (string)
createdDateTo (string)
dueDateFrom (string)
dueDateTo (string)
value (number)
status (string)
friendlyId (string)
observation (string)
creditAccountId (string) required
customer_credit/get_api_creditcontrol_accounts_by_credit_account_id_invoices_by_invoice_idReturns data from a specific invoice using invoiceId. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | RescreditAccountId (string)
invoiceId (string)
Content-Type (string) required
Accept (string) required
customer_credit/put_api_creditcontrol_accounts_by_credit_account_id_invoices_by_invoice_idUpdates invoice's status, observation and paymentLink attributes. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CacreditAccountId (string)
invoiceId (string)
Content-Type (string) required
Accept (string) required
friendlyId (string)
data: {
. status (string)
. observation (string)
. paymentLink (string)
} (object) required
customer_credit/delete_api_creditcontrol_accounts_by_credit_account_id_invoices_by_invoice_idChanges the status of a specific invoice invoiceId to Cancelled. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CatcreditAccountId (string)
invoiceId (string)
Content-Type (string) required
Accept (string) required
customer_credit/get_api_creditcontrol_accounts_by_credit_account_id_invoicesReturns associated invoices given a specific creditAccountId. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategocreditAccountId (string)
Content-Type (string) required
Accept (string) required
customer_credit/post_api_creditcontrol_accounts_by_credit_account_id_invoices_by_invoice_id_paymentsRecords the payment of an invoice. This operation causes a balance restore with the invoice value to the checking account. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are tcreditAccountId (string)
invoiceId (string)
Content-Type (string) required
Accept (string) required
customer_credit/put_api_creditcontrol_accounts_by_credit_account_id_invoices_by_invoice_id_postponementPostpones an invoice by the amount of time defined on the dueDays field number of days for the invoice to be postponed by. This operation updates the invoice field dueDate. ⚠️ Before making this request, access the endpoint Retrieve store configurationhttps://developers.vtex.com/docs/api-reference/customer-credit-api get-/api/creditcontrol/storeconfig to check whether the option to postpone invoice is enabled in the store invoicePostponementLimit: value greater than 0 and postponementEnabcreditAccountId (string)
invoiceId (string)
Content-Type (string) required
Accept (string) required
data: {
. dueDays (number)
} (object) required
customer_credit/get_api_creditcontrol_accountsRetrieves a list of all customer credit accountshttps://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU in the store. ℹ️ You can use the queries below individually or combined to obtain a more accurate search result. If your store has more than 20 customer credit accounts and you do not use any queries in the call, only the first 20 account records will appear in the response body. ℹ️ Query params can be used individually or combined.Content-Type (string) required
Accept (string) required
from (string)
to (string)
status (string)
email (string)
customer_credit/post_api_creditcontrol_accountsOpens a customer credit accounthttps://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU on your store. ⚠️ This request should only be used if you do not have an account yet registered. If you already have an account open or closed and want to create or modify an account, go to Update account informationhttps://developers.vtex.com/docs/api-reference/customer-credit-api put-/api/creditcontrol/accounts/-creditAccountId- endpoint. PermisContent-Type (string) required
Accept (string) required
data: {
. document (string)
. documentType (string)
. email (string)
. creditLimit (string)
. description (string)
. tolerance (string)
} (object) required
customer_credit/get_api_creditcontrol_accounts_by_credit_account_idRetrieves a customer credit accounthttps://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU by the credit account identification. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. OtherwcreditAccountId (string)
Content-Type (string) required
Accept (string) required
customer_credit/delete_api_creditcontrol_accounts_by_credit_account_idCloses a customer credit accounthttps://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403creditAccountId (string)
Content-Type (string) required
Accept (string) required
data: {
. document (string)
. documentType (string)
. email (string)
} (object) required
customer_credit/put_api_creditcontrol_accounts_by_credit_account_idUpdates information on a customer credit accounthttps://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive acreditAccountId (string)
Content-Type (string) required
Accept (string) required
data: {
. email (string)
. document (string)
. documentType (string)
. creditLimit (number)
. tolerance (number)
} (object) required
customer_credit/get_api_creditcontrol_accounts_by_credit_account_id_statementsRetrieves the customer credit accounthttps://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU statements. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive acreditAccountId (string)
Content-Type (string) required
Accept (string) required
customer_credit/put_api_creditcontrol_accounts_by_credit_account_id_creditlimitIncreases or decreases the credit limit of a customer credit accounthttps://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. OtherwisecreditAccountId (string)
Content-Type (string) required
Accept (string) required
data: {
. value (number)
} (object) required
customer_credit/put_api_creditcontrol_accounts_by_credit_account_id_statements_by_statement_idCreates a debit value updating the account balance. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResoucreditAccountId (string)
statementId (string)
Content-Type (string) required
Accept (string) required
data: {
. value (string)
} (object) required
customer_credit/put_api_creditcontrol_accounts_by_credit_account_id_transactions_by_transaction_id_settlementCreates an invoice or update its value for an order placed in the store that used customer credit as a payment method. ℹ️ If payment for the order is made in installments, you can create an invoice for each installment. The first invoice will be due in 30 days, and subsequent invoices will be due 30 days after the previous invoice. . Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate LicreditAccountId (string)
transactionId (string)
Content-Type (string) required
Accept (string) required
data: {
. value (number)
} (object) required
customer_credit/post_api_creditcontrol_accounts_by_credit_account_id_transactionsCreates a Pre-Authorization. Also known as authorization hold, card authorization or pre-auth, pre-authorization is the practice of holding this balance as unavailable until either the merchant clears the transaction, also called settlement, or the hold falls off. This operation does not appear in statements, but the available balance will be updated. The result of this operation is generating a transactionId pre-authorization identification to use in a settlement. Permissions AnycreditAccountId (string)
Content-Type (string) required
Accept (string) required
data: {
. value (number)
. settle (boolean)
. installments (number)
. expirationDate (string)
} (object) required
customer_credit/put_api_creditcontrol_accounts_by_credit_account_id_transactions_by_transaction_idUpdates information for a specific pre-authorization request. ⚠️ This call can only be used for pre-authorizations that have not yet been captured or canceled. Also known as authorization hold, card authorization or pre-auth, pre-authorization is the practice of holding this balance as unavailable until either the merchant clears the transaction, also called settlement, or the hold falls off. This operation does not appear in statements but the available balance will be updated. PcreditAccountId (string)
transactionId (string)
Content-Type (string) required
Accept (string) required
data: {
. value (number)
. settle (boolean)
. installments (number)
} (object) required
customer_credit/delete_api_creditcontrol_accounts_by_credit_account_id_transactions_by_transaction_idCancels a pre-authorization created by the Create a Pre-Authorizationhttps://developers.vtex.com/docs/api-reference/customer-credit-api post-/api/creditcontrol/accounts/-creditAccountId-/transactions endpoint. ⚠️ The pre-authorization can only be deleted by this endpoint if it was created with the settled field set to false previously. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate LicreditAccountId (string)
transactionId (string)
Content-Type (string) required
Accept (string) required
customer_credit/post_api_creditcontrol_accounts_by_credit_account_id_holdersAdds a new account holder to the customer credit accounthttps://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU. This new user can share the account's credit limit with users already registered on the account. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resocreditAccountId (string)
Content-Type (string) required
Accept (string) required
data: {
. claims (object)
} (object) required
customer_credit/delete_api_creditcontrol_accounts_by_credit_account_id_holders_by_holder_idDeletes an account holder from the customer credit accounthttps://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they willcreditAccountId (string)
holderId (string)
Content-Type (string) required
Accept (string) required
customer_credit/put_api_creditcontrol_accounts_by_credit_account_id_toleranceModifies the credit tolerance amount to increase the credit limit on a customer credit accounthttps://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully rucreditAccountId (string)
Content-Type (string) required
Accept (string) required
data: {
. value (number)
} (object) required
customer_credit/post_api_creditcontrol_accounts_by_credit_account_id_transactions_by_transaction_id_refundsRefunds a value from an already settled transaction. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResocreditAccountId (string)
transactionId (string)
Content-Type (string) required
Accept (string) required
data: {
. value (number)
} (object) required
customer_credit/get_api_creditcontrol_storeconfigGets store configuration data related to customer credit accountshttps://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise theContent-Type (string) required
Accept (string) required
customer_credit/put_api_creditcontrol_storeconfigCreates or changes store configuration data related to customer credit accountshttps://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request.Content-Type (string) required
Accept (string) required
data: {
. dailyInterestRate (number)
. invoicePostponementLimit (number)
. taxRate (number)
. maxPostponementDays (number)
. defaultCreditValue (number)
. maxPreAuthorizationGrowthRate (number)
. myCreditsEnabled (boolean)
. toleranceEnabled (boolean)
. automaticCheckingAccountCreationEnabled (boolean)
. postponementEnabled (boolean)
. notificationsSettings (object)
} (object) required
customer_credit/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
data_subject_rights/post_api_user_rights_create_and_process_delete_user_dataDeletes a given customer's data collected in your store by Checkout, Orders, VTEX ID and Profile System. Only orders with invoiced or canceled status are erased in this request. ❗ This API is currently in closed alpha testing stage, which means that only specific customers can access it now. Do not share this documentation with people outside of your company. If you do not have access yet, please refer to the Erasing customer datahttps://help.vtex.com/en/tutorial/erasing-customer-data--1RContent-Type (string) required
Accept (string) required
an (string)
data: {
. email (string)
} (object) required
data_subject_rights/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
default_values/post_api_dataentities_default_values_documentsCreates a document with a set of default values for a specific organization unit. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this reqContent-Type (string) required
Accept (string) required
data: {
. id (string)
. defaultValues (array)
} (object) required
default_values/get_api_dataentities_default_values_documents_by_unit_idRetrieves the default values for a specific organization unit in the VTEX Data Entity by making a GET request. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be ableunitId (string)
Accept (string) required
_schema (string) required
_fields (string) required
default_values/patch_api_dataentities_default_values_documents_by_unit_idUpdates the default values for a specific organization unit. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, theyunitId (string)
Content-Type (string) required
Accept (string) required
data: {
. id (string)
. defaultValues (array)
} (object) required
default_values/delete_api_dataentities_default_values_documents_by_unit_idDeletes all default values for a specific organization unit. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, theyunitId (string)
Accept (string) required
default_values/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
delivery_promise_notification/put_api_delivery_promises_external_sellers_by_seller_id_productsCreates or fully updates delivery promises for one or more external seller'shttps://help.vtex.com/en/tutorial/integration-guide-for-marketplaces-seller-non-vtex--yMji0ow0rQuYgQsg26Kus items, notifying VTEX of changes in product availability and delivery promises. The Delivery Promise Notification API notifies the VTEX store of the external seller's product availability and delivery promises — that is, in which delivery zones, times, and methods the product is available. ℹ️ This API is intesellerId (string)
an (string) required
Content-Type (string) required
Accept (string) required
data (array) required
delivery_promise_notification/patch_api_delivery_promises_external_sellers_by_seller_id_items_by_item_idUpdates one or more delivery promises of a single external seller'shttps://help.vtex.com/en/tutorial/integration-guide-for-marketplaces-seller-non-vtex--yMji0ow0rQuYgQsg26Kus item, identified by the path parameter itemId. The Delivery Promise Notification API notifies the VTEX store of the external seller's product availability and delivery promises — that is, in which delivery zones, times, and methods the product is available. ℹ️ This API is intended only for external sellershttps://helpsellerId (string)
itemId (string)
Content-Type (string) required
Accept (string) required
data: {
. availability (integer)
. promises (array)
. timestamp (string)
} (object) required
delivery_promise_notification/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
delivery_promise_suggestions/post_api_logistics_shipping_delivery_zones_search_v2Retrieves available delivery zones based on location information. This endpoint helps determine which delivery zones are applicable for a given address, using postal code, geographic coordinates, and country. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfullyContent-Type (string) required
Accept (string) required
data: {
. zipCode (string)
. geoCoordinates (string)
. country (string)
} (object) required
delivery_promise_suggestions/post_api_logistics_shipping_pickuppoints_searchRetrieves available pickup points based on location information and distance constraints. This endpoint helps find pickup locations near a given address, using postal code, geographic coordinates, country, and optional maximum distance. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6eukContent-Type (string) required
Accept (string) required
maxDistance (number)
data: {
. zipCode (string)
. coordinate (object)
. country (string)
} (object) required
delivery_promise_suggestions/post_api_delivery_promise_suggestions_searchRetrieves delivery and pickup suggestions for a batch of products. The response contains suggestions for each requested product, including available delivery and pickup optionshttps://help.vtex.com/docs/tutorials/delivery-options-beta creating-delivery-options with timing information and selection criteria tags e.g., fastest, nearest. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate LicenseContent-Type (string) required
Accept (string) required
data: {
. products (array)
. deliveryZonesHash (string)
. pickupsHash (string)
} (object) required
delivery_promise_suggestions/get_api_delivery_promise_suggestionsRetrieves delivery and pickup suggestions for products using query parameters. This method supports caching, bookmarking, and browser optimizations. The response contains suggestions for each requested product, including available delivery and pickup optionshttps://help.vtex.com/docs/tutorials/delivery-options-beta creating-delivery-options with timing information and selection criteria tags e.g., fastest, nearest. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/aContent-Type (string) required
Accept (string) required
products0.productId (string) required
products0.itemId (string)
deliveryZonesHash (string) required
pickupsHash (string) required
delivery_promise_suggestions/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
giftcard_hub/get_api_giftcardprovidersReturns a collection of gift card providers from a store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category |REST-Range (string)
giftcard_hub/get_api_giftcardproviders_by_gift_card_provider_idReturns a gift card provider from a store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -giftCardProviderId (string)
giftcard_hub/put_api_giftcardproviders_by_gift_card_provider_idCreate or update a gift card provider from a store. ⚠️ The X-PROVIDER-API-AppKey and X-PROVIDER-API-AppToken headers are not mandatory for the native VTEX gift card, only for external gift card providershttps://developers.vtex.com/updates/release-notes/2024-05-27-changes-in-authentication-requirements-for-external-gift-card-providers. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate LicegiftCardProviderId (string)
giftcard_hub/delete_api_giftcardproviders_by_gift_card_provider_idDelete a gift card provider from a store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --giftCardProviderId (string)
giftcard_hub/post_api_giftcardproviders_by_gift_card_provider_id_giftcardsCreates a gift card in a gift card provider. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | |giftCardProviderId (string)
giftcard_hub/post_api_giftcardproviders_by_gift_card_provider_id_giftcards_searchReturns all gift cards from a gift card provider according to the filters. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | ProdgiftCardProviderId (string)
REST-Range (string)
giftcard_hub/get_api_giftcardproviders_by_gift_card_provider_id_giftcards_by_gift_card_idReturns a specific gift card from a gift card provider. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | RegiftCardProviderId (string)
giftCardId (string)
giftcard_hub/get_api_giftcardproviders_by_gift_card_provider_id_giftcards_by_gift_card_id_transactionsReturns the IDs of all transactions performed on a gift card. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategorgiftCardProviderId (string)
giftCardId (string)
giftcard_hub/post_api_giftcardproviders_by_gift_card_provider_id_giftcards_by_gift_card_id_transactionsCreates a transaction credit or debit to a gift card. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResogiftCardProviderId (string)
giftCardId (string)
giftcard_hub/get_api_giftcardproviders_by_gift_card_provider_id_giftcards_by_gift_card_id_transactions_by_transaction_idReturns a specific transaction from a gift card. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResourcegiftCardProviderId (string)
giftCardId (string)
transactionId (string)
giftcard_hub/get_api_giftcardproviders_by_gift_card_provider_id_giftcards_by_gift_card_id_transactions_by_t_id_authorizationReturns information about a gift card transaction authorization. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CatgiftCardProviderId (string)
giftCardId (string)
tId (string)
giftcard_hub/get_api_giftcardproviders_by_gift_card_provider_id_giftcards_by_gift_card_id_transactions_by_t_id_settlementsReturns all transactions settlements for a specific gift card. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategogiftCardProviderId (string)
giftCardId (string)
tId (string)
giftcard_hub/post_api_giftcardproviders_by_gift_card_provider_id_giftcards_by_gift_card_id_transactions_by_t_id_settlementsCreates a transaction settlement for a specific gift card. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category |giftCardProviderId (string)
giftCardId (string)
tId (string)
data: {
. value (number)
. requestId (string)
} (object) required
giftcard_hub/get_api_giftcardproviders_by_gift_card_provider_id_giftcards_by_gift_card_id_transactions_by_t_id_cancellationsReturns all transactions cancelled for a specific gift card. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategorygiftCardProviderId (string)
giftCardId (string)
tId (string)
giftcard_hub/post_api_giftcardproviders_by_gift_card_provider_id_giftcards_by_gift_card_id_transactions_by_t_id_cancellationsCreates a cancellation transaction to a gift card. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResourcgiftCardProviderId (string)
giftCardId (string)
tId (string)
giftcard_hub/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
giftcard/post_giftcardsCreates a gift card for a specific user. ⚠️ The redemptionCode field is auto-generated during gift card creation and cannot be set to an arbitrary value. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a statNo parameters
giftcard/get_giftcards_by_gift_card_idReturns information for a specific gift card. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource |giftCardId (string)
giftcard/post_giftcards_searchReturns a list of all gift cards available for a specific customer's cart. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | ProdREST-Range (string)
data: {
. cart
. client
} (object) required
giftcard/get_giftcards_by_gift_card_id_transactionsReturns the IDs of all transactions performed on a gift card. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategorgiftCardId (string)
giftcard/post_giftcards_by_gift_card_id_transactionsCreates a transaction credit or debit to a gift card and authorize the item reservation. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpogiftCardId (string)
data: {
. operation (string)
. value (number)
. description (string)
. redemptionToken (string)
. redemptionCode (string)
. requestId (string)
. orderInfo
} (object) required
giftcard/get_giftcards_by_gift_card_id_transactions_by_transaction_idReturns a specific transaction for a gift card. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource |giftCardId (string)
transactionId (string)
giftcard/get_giftcards_by_gift_card_id_transactions_by_transaction_id_authorizationReturns information about a gift card transaction authorization. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategiftCardId (string)
transactionId (string)
giftcard/get_giftcards_by_gift_card_id_transactions_by_transaction_id_cancellationsReturns all transactions cancelled for a specific gift card. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategorygiftCardId (string)
transactionId (string)
giftcard/post_giftcards_by_gift_card_id_transactions_by_transaction_id_cancellationsThis request can be used to: 1. Cancel a transaction for a specific gift card. 2. Cancel an item's reservation or create a refund. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. TgiftCardId (string)
transactionId (string)
data: {
. value (number)
. requestId (string)
} (object) required
giftcard/get_giftcards_by_gift_card_id_transactions_by_transaction_id_settlementsReturns all transactions settlements for a specific gift card. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategogiftCardId (string)
transactionId (string)
giftcard/post_giftcards_by_gift_card_id_transactions_by_transaction_id_settlementsCreates a transaction settlement for a specific gift card. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category |giftCardId (string)
transactionId (string)
data: {
. value (number)
. requestId (string)
} (object) required
giftcard/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
giftcard_provider_protocol/post_giftcards_searchReturns a list of all gift cards available from a gift card provider for a specific customer's cart. For scenarios in which there is a gift card with no balance associated with the customer, the payment provider must choose one of the options below to display the information in the response body and implement it on the endpoint: - Response body returns the complete gift card data mentioning the balance field equal to 0 'balance': 0: In this option, whenever the customer has associated aREST-Range (string)
giftcard_provider_protocol/get_giftcards_by_gift_card_idReturns information for a specific gift card from a gift card provider. ℹ️ This request is made from VTEX to the gift card payment provider. ℹ️ This endpoint must respond to the flow triggered by the Add payment datahttps://developers.vtex.com/docs/api-reference/checkout-api post-/api/checkout/pub/orderForm/-orderFormId-/attachments/paymentData endpoint within 1.5 seconds. If the response time exceeds 1.5 seconds, the Checkout UI will show an error message stating that the gift card is igiftCardId (string)
giftcard_provider_protocol/post_giftcardsCreates a gift card for a specific user in a gift card provider. ℹ️ This request is made from VTEX to the gift card payment provider. Permissions Check with your service provider to know what permissions are needed.No parameters
giftcard_provider_protocol/post_giftcards_by_gift_card_id_transactionsCreates a transaction credit or debit for a gift card in a gift card provider and authorizes the item reservation. ℹ️ This request is made from VTEX to the gift card payment provider. Permissions Check with your service provider to know what permissions are needed.giftCardId (string)
giftcard_provider_protocol/get_giftcards_by_gift_card_id_transactionsReturns the IDs of all transactions performed in a gift card provider for a specific gift card. ℹ️ This request is made from VTEX to the gift card payment provider. Permissions Check with your service provider to know what permissions are needed.giftCardId (string)
giftcard_provider_protocol/get_giftcards_by_gift_card_id_transactions_by_transaction_idReturns a specific transaction for a gift card from a gift card provider. ℹ️ This request is made from VTEX to the gift card payment provider. Permissions Check with your service provider to know what permissions are needed.giftCardId (string)
transactionId (string)
giftcard_provider_protocol/get_giftcards_by_gift_card_id_transactions_by_transaction_id_authorizationReturns information about a gift card transaction authorization from a gift card provider. ℹ️ This request is made from VTEX to the gift card payment provider. Permissions Check with your service provider to know what permissions are needed.giftCardId (string)
transactionId (string)
giftcard_provider_protocol/post_giftcards_by_gift_card_id_transactions_by_transaction_id_cancellationsThis request can be used to: 1. Cancel a transaction for a specific gift card in a gift card provider. 2. Cancel an item's reservation or create a refund. ℹ️ This request is made from VTEX to the gift card payment provider. Permissions Check with your service provider to know what permissions are needed.giftCardId (string)
transactionId (string)
giftcard_provider_protocol/get_giftcards_by_gift_card_id_transactions_by_transaction_id_cancellationsReturns all transactions cancelled for a specific gift card from a gift card provider. ℹ️ This request is made from VTEX to the gift card payment provider. Permissions Check with your service provider to know what permissions are needed.giftCardId (string)
transactionId (string)
giftcard_provider_protocol/post_giftcards_by_gift_card_id_transactions_by_t_id_settlementsCreates a transaction settlement for a specific gift card from a gift card provider. ℹ️ This request is made from VTEX to the gift card payment provider. Permissions Check with your service provider to know what permissions are needed.giftCardId (string)
tId (string)
giftcard_provider_protocol/get_giftcards_by_gift_card_id_transactions_by_t_id_settlementsReturns all transactions settlements for a specific gift card from a gift card provider. ℹ️ This request is made from VTEX to the gift card payment provider. Permissions Check with your service provider to know what permissions are needed.giftCardId (string)
tId (string)
giftcard_provider_protocol/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
headless_cms/get_v_cms_api_by_project_idRetrieves data from all Content Types. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --------------- | -------projectId (string)
headless_cms/get_v_cms_api_by_project_id_by_content_typeGets data from all pages of a given content type. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --------------projectId (string)
content-type (string)
page (string)
versionId (string)
releaseId (string)
filtersfield (string)
headless_cms/get_v_cms_api_by_project_id_by_content_type_by_document_idGets all data from a given page. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --------------- | -------------projectId (string)
content-type (string)
document-id (string)
versionId (string)
releaseId (string)
headless_cms/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
intelligent_search/servers_top_searchesNo description availableNo parameters
intelligent_search/get_top_searchesLists the 10 most searched terms in the past 14 days. For more information, check the Intelligent Search Autocompletehttps://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4gXFsEWjF7QF7UtI2GAvhL guide. Permissions This endpoint does not require authenticationhttps://developers.vtex.com/docs/guides/authentication or permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.locale (string)
intelligent_search/servers_autocomplete_suggestionsNo description availableNo parameters
intelligent_search/get_autocomplete_suggestionsLists the suggested terms and attributes similar to the search term. For more information, check the Intelligent Search Autocompletehttps://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4gXFsEWjF7QF7UtI2GAvhL guide. Permissions This endpoint does not require authenticationhttps://developers.vtex.com/docs/guides/authentication or permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.query (string)
locale (string)
intelligent_search/servers_correction_searchNo description availableNo parameters
intelligent_search/get_correction_searchTries to correct a misspelled term from the search. Permissions This endpoint does not require authenticationhttps://developers.vtex.com/docs/guides/authentication or permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.query (string)
locale (string)
intelligent_search/servers_banners_by_facetsNo description availablefacets (string)
intelligent_search/get_banners_by_facetsLists the banners registered for a given query. Check the configuring banners documentationhttps://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4ViKEivLJtJsvpaW0aqIQ5 for a full explanation of the banner feature. Permissions This endpoint does not require authenticationhttps://developers.vtex.com/docs/guides/authentication or permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.facets (string)
query (string)
locale (string)
intelligent_search/servers_search_suggestionsNo description availableNo parameters
intelligent_search/get_search_suggestionsLists suggested terms similar to the search term. For more information, check the Intelligent Search Autocompletehttps://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4gXFsEWjF7QF7UtI2GAvhL guide. Permissions This endpoint does not require authenticationhttps://developers.vtex.com/docs/guides/authentication or permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.query (string)
locale (string)
intelligent_search/servers_product_search_by_facetsNo description availablefacets (string)
intelligent_search/get_product_search_by_facetsLists the active products for a given query. ⚠️ Required facet: Only the trade-policy facet is required in the path. All other facets such as productClusterIds, category, color, etc. are optional filters that can be used to narrow down the search results. When no additional facets are provided, all products for the trade policy will be returned. ⚠️ When possible, use the store's production domain in the URL for example, https://apiexamples.com/api/io/_v/api/intelligent-search for a betterfacets (string)
query (string)
count (number)
page (number)
sort (string)
locale (string)
hideUnavailableItems (boolean)
simulationBehavior (string)
showSponsored (boolean)
sponsoredCount (string)
advertisementPlacement (string)
repeatSponsoredProducts (boolean)
intelligent_search/servers_facets_by_facetsNo description availablefacets (string)
intelligent_search/get_facets_by_facetsLists the possible facets for a given query. ⚠️ When possible, use the store's production domain in the URL for example, https://apiexamples.com/api/io/_v/api/intelligent-search for a better performance. This is particularly important for headless integrations. In case it's not possible to use the store's production URL, prefer using https://accountName.vtexcommercestable.com.br/api/io/_v/api/intelligent-search. If using this option in a fully headless store with no store domain configuredfacets (string)
query (string)
locale (string)
hideUnavailableItems (boolean)
intelligent_search/servers_pickup_point_availability_by_facetsNo description availablefacets (string)
intelligent_search/get_pickup_point_availability_by_facetsRetrieves the list of available pickup points with their IDs, distances, addresses, and business hours. This endpoint returns pickup points sorted by distance from the provided coordinates. ⚠️ Required facet: Only the tradePolicy trade policy/sales channel facet is required. All product filters, including productClusterIds, are optional and can be provided as query parameters to narrow down the results. When no product filters are provided, all available pickup points for the trade policy wilfacets (string)
query (string)
an (string) required
coordinates (string)
zip-code (string)
country (string)
deliveryZonesHash (string)
pickupsHash (string)
intelligent_search/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
intelligent_search_events_api_headless/post_eventCreates search events to integrate with VTEX Intelligent Search using a headless implementation. Read VTEX Intelligent Search Events API - Headless - Overviewhttps://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless for more information on event types and user identification. ⚠️ This API applies only to Headless scenarios. It doesn't apply to stores using VTEX's storefront solution, since they are natively integrated with Intelligent Search. PermissionsaccountName (string)
data (undefined) required
intelligent_search_events_api_headless/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
legacy_cms_portal/put_api_catalog_system_pvt_virtualfolder_changeurischema_by_protocolUpdates all account's website protocols to HTTP or HTTPS. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have the appropriate License Manager resourcehttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, they will receive a status code 403 error. This is the applicable resource for this endpoint: | Product | Category | Resource | | -----protocol (string)
Content-Type (string) required
Accept (string) required
legacy_cms_portal/put_api_catalog_system_pvt_virtualfolder_site_by_website_id_changeurischema_by_protocolUpdates a specific website protocol to HTTP or HTTPS. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have the appropriate License Manager resourcehttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, they will receive a status code 403 error. This is the applicable resource for this endpoint: | Product | Category | Resource | | ---------websiteId (string)
protocol (string)
Content-Type (string) required
Accept (string) required
legacy_cms_portal/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
license_manager/get_api_license_manager_users_by_user_idAllows you to obtain information about an admin user, using the userId as the identifier. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this enuserId (string)
Content-Type (string) required
Accept (string) required
license_manager/delete_api_license_manager_users_by_user_idAllows you to delete an admin user from the database, using the userId as the identifier. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this enuserId (string)
Content-Type (string) required
Accept (string) required
license_manager/post_api_license_manager_usersAllows you to create an admin user by providing an email mandatory and name optional. The email must be in a valid format. The success response will contain the generated userId for that user. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this requedata: {
. name (string)
. email (string)
} (object) required
license_manager/get_api_license_manager_site_pvt_logins_list_pagedReturns a list of registered admin users. The response is divided in pages. The query parameter numItems defines the number of items in each page, and consequently the amount of pages for the whole list. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully runContent-Type (string) required
Accept (string) required
numItems (integer)
pageNumber (integer)
sort (string)
sortType (string)
license_manager/put_api_license_manager_users_by_user_id_rolesAllows you to add License Manager roleshttps://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc to a particular admin user or API key by specifying the list of role IDs on the request body. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this ruserId (string)
data (array) required
license_manager/get_api_license_manager_users_by_user_id_rolesRetrieves License Manager roleshttps://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc of a particular admin user or API key. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. ThuserId (string)
Content-Type (string) required
Accept (string) required
license_manager/delete_api_license_manager_users_by_user_id_roles_by_role_idAllows you to remove a License Manager rolehttps://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc from a specific admin user or API key. This method only allows the removal of one role per request. The role's ID must be specified on the request path, not on the request body. Note that a successful response returns a 204 response with an empty body. A deletion on a role or user that does not exist will also return a 204. Thus, this method should not be used to verify the existence ofuserId (string)
roleId (string)
Content-Type (string) required
Accept (string) required
license_manager/get_api_license_manager_site_pvt_roles_list_pagedReturns a list of License Manager roleshttps://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc. The response is divided in pages. The query parameter numItems defines the number of items in each page, and consequently the amount of pages for the whole list. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-reContent-Type (string) required
Accept (string) required
numItems (integer)
pageNumber (integer)
sort (string)
sortType (string)
license_manager/post_api_vlm_appkeysCreates a new pair of API Key and appToken. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource |data: {
. label (string)
} (object) required
license_manager/get_api_vlm_appkeysRetrieves all application keys from an account. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResourceContent-Type (string) required
license_manager/put_api_vlm_appkeys_by_idActivates or deactivates an appKey by its ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource |id (string)
data: {
. isActive (boolean)
} (object) required
license_manager/get_api_vlm_account_storesRetrieves the stores of the account and their respective hosts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CatNo parameters
license_manager/get_api_vlm_accountRetrieves information from an account, such as company and sponsor user details, stores, and appTokens. This endpoint only accepts requests from the host list designated for that store. If you want to try this request from this portal, be sure to add it to the list. Learn how to add hosts to the list in How to manage accountshttps://help.vtex.com/en/tutorial/how-to-manage-accounts--tutorials_6285 . Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authenticaNo parameters
license_manager/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
logistics/get_api_logistics_pvt_shipping_policies_by_idRetrieves information from a shipping policyhttps://help.vtex.com/en/tutorial/shipping-policy--tutorials_140 from your store, searching by shipping policy ID. ⚠️ While most endpoints return time fields in UTC format, this endpoint returns Scheduled Delivery related time fields adjusted to the time zone configured for the VTEX account. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate Liceid (string)
Content-Type (string) required
Accept (string) required
logistics/delete_api_logistics_pvt_shipping_policies_by_idDeletes a shipping policyhttps://help.vtex.com/en/tutorial/shipping-policy--tutorials_140 of your store, searching by shipping policy ID. ⚠️ While most endpoints return time fields in UTC format, this endpoint returns Scheduled Delivery related time fields adjusted to the time zone configured for the VTEX account. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourcid (string)
logistics/put_api_logistics_pvt_shipping_policies_by_idUpdates information about a shipping policyhttps://help.vtex.com/en/tutorial/shipping-policy--tutorials_140 of your store, searching by shipping policy ID. ⚠️ While most endpoints return time fields in UTC format, this endpoint returns Scheduled Delivery related time fields adjusted to the time zone configured for the VTEX account. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate Licenid (string)
data: {
. name (string)
. shippingMethod (string)
. deliveryOnWeekends (boolean)
. maxDimension (object)
. cubicWeightSettings (object)
. modalSettings (object)
. isActive (boolean)
. deliveryScheduleSettings (object)
} (object) required
logistics/get_api_logistics_pvt_shipping_policiesLists all shipping policieshttps://help.vtex.com/en/tutorial/shipping-policy--tutorials_140 from your store. ⚠️ While most endpoints return time fields in UTC format, this endpoint returns Scheduled Delivery related time fields adjusted to the time zone configured for the VTEX account. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutopage (integer)
perPage (integer)
logistics/post_api_logistics_pvt_shipping_policiesConfigure a new shipping policyhttps://help.vtex.com/en/tutorial/shipping-policy--tutorials_140 for your store. ⚠️ While most endpoints return time fields in UTC format, this endpoint returns Scheduled Delivery related time fields adjusted to the time zone configured for the VTEX account. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/endata: {
. id (string)
. name (string)
. shippingMethod (string)
. weekendAndHolidays (object)
. maxDimension (object)
. numberOfItemsPerShipment (integer)
. minimumValueAceptable (number)
. maximumValueAceptable (number)
. deliveryScheduleSettings (object)
. carrierSchedule (array)
. cubicWeightSettings (object)
. modalSettings (object)
. businessHourSettings (object)
. pickupPointsSettings (object)
. isActive (boolean)
} (object) required
logistics/post_api_logistics_pvt_configuration_freights_by_carrier_id_values_updateCreates or updates freight values for your store's carriers. Learn more in Shipping rate templatehttps://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they willcarrierId (string)
data (array) required
logistics/get_api_logistics_pvt_configuration_freights_by_carrier_id_by_cep_valuesLists freight values appointed to your store's carriers, searching by carrier ID and postal code cep. The information is retrieved from your shipping rate templatehttps://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127 configurations. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrCcarrierId (string)
cep (string)
logistics/get_api_logistics_pvt_configuration_carriers_by_carrier_id_getdayofweekblockedLists all blocked delivery windows of your store's shipping policies, searching by carrier ID. ⚠️ While most of our API endpoints return time fields in UTC format, this endpoint returns Scheduled Delivery related time fields adjusted to the configured time zone of the account. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/licecarrierId (string)
logistics/post_api_logistics_pvt_configuration_carriers_by_carrier_id_adddayofweekblockedAdds blocked delivery windows for your store's shipping policies. ⚠️ While most of our API endpoints return time fields in UTC format, this endpoint returns time adjusted to the configured time zone of the account. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to succarrierId (string)
data (string) required
logistics/post_api_logistics_pvt_configuration_carriers_by_carrier_id_removedayofweekblockedRemoves blocked delivery windows configured for a shipping policy of your shipping strategyhttps://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3. ⚠️ While most of our endpoints return time values in UTC format, this endpoint returns time adjusted to the time zone set for the account. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://hcarrierId (string)
data (string) required
logistics/post_api_logistics_pvt_configuration_docksCreates a new loading dockhttps://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj or updates an existing one for your store's shipping strategyhttps://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3data: {
. id (string)
. name (string)
. priority (integer)
. dockTimeFake (string)
. timeFakeOverhead (string)
. salesChannels (array)
. salesChannel (string)
. freightTableIds (array)
. wmsEndPoint (string)
. address (object)
} (object) required
logistics/get_api_logistics_pvt_configuration_docksRetrieves information about all loading dockshttps://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj of your store's shipping strategyhttps://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be ablNo parameters
logistics/get_api_logistics_pvt_configuration_docks_by_dock_idRetrieves information about a loading dockhttps://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj of your store's shipping strategyhttps://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3, searching by dock ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQfdockId (string)
logistics/delete_api_logistics_pvt_configuration_docks_by_dock_idDeletes a loading dockhttps://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj, searching by dock ID. Successful requests receive a 200 OK status code with true in the response body. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run thisdockId (string)
logistics/post_api_logistics_pvt_configuration_docks_by_dock_id_activationActivates a loading dockhttps://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj of your store's shipping strategyhttps://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3, searching by dock ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be abdockId (string)
logistics/post_api_logistics_pvt_configuration_docks_by_dock_id_deactivationDeactivates a loading dockhttps://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj of your store's shipping strategyhttps://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3, searching by dock ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to bedockId (string)
logistics/post_api_logistics_pvt_configuration_warehousesCreates or updates a warehousehttps://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources fordata: {
. id (string)
. name (string)
. warehouseDocks (array)
. priority (integer)
. isActive (boolean)
} (object) required
logistics/get_api_logistics_pvt_configuration_warehousesLists all warehouseshttps://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb set up in your store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable reNo parameters
logistics/get_api_logistics_pvt_configuration_warehouses_by_warehouse_idRetrieves information of a warehousehttps://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb, searching by warehouse ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. ThesewarehouseId (string)
logistics/delete_api_logistics_pvt_configuration_warehouses_by_warehouse_idDeletes a warehousehttps://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb, searching by warehouse ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicabwarehouseId (string)
logistics/post_api_logistics_pvt_configuration_warehouses_by_warehouse_id_activationActivates a warehousehttps://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb, searching by warehouse ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicwarehouseId (string)
logistics/post_api_logistics_pvt_configuration_warehouses_by_warehouse_id_deactivationDeactivates a warehousehttps://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb, searching by warehouse ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applwarehouseId (string)
logistics/get_api_logistics_pvt_inventory_skus_by_sku_idLists inventoryhttps://help.vtex.com/en/tutorial/inventory-management--tutorials_139 information, searching by SKU ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applskuId (string)
logistics/get_api_logistics_pvt_inventory_items_by_sku_id_warehouses_by_warehouse_idLists inventoryhttps://help.vtex.com/en/tutorial/inventory-management--tutorials_139 information, searching by warehousehttps://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this requestskuId (string)
warehouseId (string)
logistics/put_api_logistics_pvt_inventory_skus_by_sku_id_warehouses_by_warehouse_idUpdates inventoryhttps://help.vtex.com/en/tutorial/inventory-management--tutorials_139 quantity and lead timehttps://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B for a given SKU in a warehouse. ℹ️ If you wish to configure lead time exclusively, use the Update inventory lead time by SKU and warehousehttps://developers.vtex.com/docs/api-reference/logistics-api patch-/api/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-/lead-time endpoint, askuId (string)
warehouseId (string)
Content-Type (string) required
Accept (string) required
data: {
. quantity (integer)
. unlimitedQuantity (boolean)
. dateUtcOnBalanceSystem (string)
. leadTime (string)
} (object) required
logistics/patch_api_logistics_pvt_inventory_skus_by_sku_id_warehouses_by_warehouse_id_quantityUpdates inventoryhttps://help.vtex.com/en/tutorial/inventory-management--tutorials_139 with a SKU count and availability for a given warehousehttps://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb. You can do it in two ways: - Define a quantity: Indicate a specific number of items of a SKU from a warehouse, and it will decrease whenever an item is sold. When the last item is sold, the SKU will run out of stock. - Set an unlimited inventory: Always have items of a SKU from askuId (string)
warehouseId (string)
Content-Type (string) required
Accept (string) required
data: {
. quantity (integer)
. unlimitedQuantity (boolean)
. dateUtcOnBalanceSystem (string)
} (object) required
logistics/patch_api_logistics_pvt_inventory_skus_by_sku_id_warehouses_by_warehouse_id_lead_timeConfigures the lead timehttps://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B for a SKU of a warehouse, and the period is added to the order's total shipping time. Among other main use caseshttps://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B main-use-cases, lead time can represent an item's manufacturing time or scenarios where there are third-party suppliers, for example. Lead time is an optional configuraskuId (string)
warehouseId (string)
Content-Type (string) required
Accept (string) required
data: {
. leadTime (string)
} (object) required
logistics/get_api_logistics_pvt_inventory_items_by_sku_id_docks_by_dock_idLists inventory information, searching by loading dockhttps://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These arskuId (string)
dockId (string)
logistics/get_api_logistics_pvt_inventory_items_by_sku_id_docks_by_dock_id_warehouses_by_warehouse_idLists inventory information from the combination of a given loading dockhttps://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj and a warehousehttps://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be abskuId (string)
dockId (string)
warehouseId (string)
logistics/get_api_logistics_pvt_inventory_items_by_item_id_warehouses_by_warehouse_id_dispatchedReservationhttps://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92 is the VTEX solution that prevents stores from selling the same item more than once. Adding products to the shopping cart does not create a reservation, this only happens after the shopper completes the purchase. This endpoint lists your inventoryhttps://help.vtex.com/en/tutorial/inventory-management--tutorials_139 information about dispatched reservations from a given warehouse. A reservation is considered ditemId (string)
warehouseId (string)
logistics/get_api_logistics_pvt_inventory_items_by_sku_id_warehouses_by_warehouse_id_supply_lotsLists supply lots of a SKU in a given warehousehttps://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicaskuId (string)
warehouseId (string)
logistics/put_api_logistics_pvt_inventory_items_by_sku_id_warehouses_by_warehouse_id_supply_lots_by_supply_lot_idCreates a new supply lot, which allows you to sell a SKU that is currently out-of-stock in your inventoryhttps://help.vtex.com/en/tutorial/inventory-management--tutorials_139 and unavailable for sales. Creating a supply lot is useful when you know the date of when the SKU will have quantity and availability for sales again. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License ManagerskuId (string)
warehouseId (string)
supplyLotId (string)
data: {
. quantity (integer)
. dateOfSupplyUtc (string)
. keepSellingAfterExpiration (boolean)
} (object) required
logistics/post_api_logistics_pvt_inventory_items_by_sku_id_warehouses_by_warehouse_id_supply_lots_by_supply_lot_id_transferTransfers a SKU from a supply lot to the currently available inventory. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | ProducskuId (string)
warehouseId (string)
supplyLotId (string)
logistics/post_availability_v1_inventory_batchCreates a new batch inventory job and returns a pre-signed URL for uploading the CSV file. The batch will be in AWAITING_UPLOAD status until the CSV is uploaded and committed. ℹ️ This feature is in early access, which means that we are working to improve it. If you want to use this feature, please contact our Support Centerhttps://support.vtex.com/hc/en-us/requests. This endpoint is part of the Batch operations section for high-throughput inventory updateshttps://help.vtex.com/en/docs/tutoAccept (string) required
logistics/post_availability_v1_inventory_batch_by_batch_id_commitConfirms that the CSV upload is complete and triggers asynchronous processing of the batch inventory. The batch status will transition to QUEUED. ℹ️ This feature is in early access, which means that we are working to improve it. If you want to use this feature, please contact our Support Centerhttps://support.vtex.com/hc/en-us/requests. This endpoint is part of the Batch operations section for high-throughput inventory updateshttps://help.vtex.com/en/docs/tutorials/updating-the-quantity-ofbatchId (string)
Accept (string) required
logistics/get_availability_v1_inventory_batch_by_batch_id_statusRetrieves the current processing status and progress information for a batch inventory job. Use this endpoint to poll the batch status and track processing progress. ℹ️ This feature is in early access, which means that we are working to improve it. If you want to use this feature, please contact our Support Centerhttps://support.vtex.com/hc/en-us/requests. This endpoint is part of the Batch operations section for high-throughput inventory updateshttps://help.vtex.com/en/docs/tutorials/updabatchId (string)
Accept (string) required
logistics/get_availability_v1_inventory_batch_by_batch_id_errorsReturns a pre-signed URL to download a CSV file containing all rows that failed processing, along with error codes and messages. The error reports are available until the batch metadata expires 7 days after batch completion. ℹ️ This feature is in early access, which means that we are working to improve it. If you want to use this feature, please contact our Support Centerhttps://support.vtex.com/hc/en-us/requests. This endpoint is part of the Batch operations section for high-throughput inbatchId (string)
Accept (string) required
logistics/put_api_logistics_pvt_configuration_holidays_by_holiday_idCreates or updates a holidayhttps://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk, searching by holiday ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. ThesholidayId (string)
data: {
. name (string)
. startDate (string)
} (object) required
logistics/get_api_logistics_pvt_configuration_holidays_by_holiday_idLists information about a holidayhttps://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk, searching by holiday ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error.holidayId (string)
logistics/delete_api_logistics_pvt_configuration_holidays_by_holiday_idDeletes a holidayhttps://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk set up in your store, searching by holiday ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 eholidayId (string)
logistics/get_api_logistics_pvt_configuration_holidaysLists information about all holidayshttps://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk configured on your store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 errNo parameters
logistics/post_api_logistics_pvt_inventory_reservationsCreates a reservationhttps://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for thdata: {
. salesChannel (string)
. lockId (string)
. autorizationExpirationTTL (string)
. deliveryItemOptions (array)
} (object) required
logistics/get_api_logistics_pvt_inventory_reservations_by_reservation_idLists information about a reservationhttps://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92, searching by reservation ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 errreservationId (string)
logistics/post_api_logistics_pvt_inventory_reservations_by_reservation_id_confirmConfirms a reservationhttps://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92, searching by reservation ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are treservationId (string)
logistics/post_api_logistics_pvt_inventory_reservations_by_reservation_id_acknowledgeAcknowledges a reservationhttps://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92, searching by reservation ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These areservationId (string)
logistics/post_api_logistics_pvt_inventory_reservations_by_reservation_id_cancelCancels a reservationhttps://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92, searching by reservation ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are threservationId (string)
logistics/get_api_logistics_pvt_inventory_reservations_by_warehouse_id_by_sku_idLists information about reservationshttps://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92, searching by a given warehousehttps://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb ID and SKU ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be ablewarehouseId (string)
skuId (string)
logistics/post_api_logistics_pvt_shipping_calculateCheckout uses this endpoint to calculate a Service Level Agreement SLA, a contract between the store and a customer about their order fulfillment conditions, such as the shipping estimated date. The calculation of the estimated date considers the shipping policyhttps://help.vtex.com/en/tutorial/shipping-policy--tutorials_140 and loading dockhttps://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj related to the order. Permissions Any user or API keyhttps://developers.vtdata (array) required
logistics/get_api_logistics_pvt_configuration_pickuppointsRetrieves information about your store pickup pointshttps://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R. ⚠️ The response is limited to 1.000 pickup points. If you need more results, you can use the List paged pickup pointshttps://developers.vtex.com/docs/api-reference/logistics-api get-/api/logistics/pvt/configuration/pickuppoints/_search endpoint. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have atNo parameters
logistics/put_api_logistics_pvt_configuration_pickuppoints_by_pickup_point_idCreates or updates a pickup pointhttps://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R of your store, searching by pickup point ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status codpickupPointId (string)
data: {
. id (string)
. name (string)
. description (string)
. instructions (string)
. formatted_address (string)
. address (object)
. isActive (boolean)
. businessHours (array)
. tagsLabel (array)
. isThirdPartyPickup (boolean)
} (object) required
logistics/get_api_logistics_pvt_configuration_pickuppoints_by_pickup_point_idRetrieves information about a pickup pointhttps://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R, searching by pickup point ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403pickupPointId (string)
logistics/delete_api_logistics_pvt_configuration_pickuppoints_by_pickup_point_idDeletes a pickup pointhttps://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R of your store, searching by pickup point ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 errorpickupPointId (string)
logistics/get_api_logistics_pvt_configuration_pickuppoints_searchLists paged pickup pointshttps://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R of your store. ⚠️ The response is limited to 100 pages. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a statpage (integer)
pageSize (integer)
keyword (string)
logistics/get_api_logistics_pvt_configuration_geoshapeLists paged polygonshttps://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138 of your store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resopage (integer)
perPage (integer)
logistics/put_api_logistics_pvt_configuration_geoshapeCreates or updates a polygonhttps://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138 of your store, using geolocation coordinates. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 4data: {
. name (string)
. geoShape (object)
} (object) required
logistics/get_api_logistics_pvt_configuration_geoshape_by_polygon_nameRetrieves information about a polygonhttps://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138 of your store, searching by polygon ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status codpolygonName (string)
logistics/delete_api_logistics_pvt_configuration_geoshape_by_polygon_nameDeletes a polygonhttps://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138 of your store, searching by polygon ID. Successful requests receive a 200 OK status code with true in the response body. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successpolygonName (string)
logistics/get_api_logistics_capacity_resources_carrier@by_capacity_type@by_shipping_policy_id_time_framesRetrieves information of all capacity reservationshttps://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz made to scheduled delivery windows in a given time range. ⚠️ While most of our API endpoints return time fields in UTC format, this endpoint returns time adjusted to the configured time zone of the VTEX account. Note that the combined string carrier@capacityType@shippingPolicyId can be referred to as a resource in request messages. Permissions AnycapacityType (string)
shippingPolicyId (string)
rangeStart (string) required
rangeEnd (string) required
logistics/get_api_logistics_capacity_resources_carrier@by_capacity_type@by_shipping_policy_id_time_frames_by_window_day_fby_window_start_time_tby_window_end_timeRetrieves capacity usage of a specific scheduled deliveryhttps://help.vtex.com/en/tutorial/entrega-agendada--22g3HAVCGLFiU7xugShOBi reservation window. ⚠️ While most API endpoints return time fields in UTC format, this endpoint returns time adjusted to the configured time zone of the VTEX account. Note that the combined string carrier@capacityType@shippingPolicyId can be referred to as a 'resource' in the API's messages. Permissions Any user or API keyhttps://developers.vtex.com/capacityType (string)
shippingPolicyId (string)
windowDay (string)
windowStartTime (string)
windowEndTime (string)
logistics/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
marketplace_apis_sent_offers/post_api_sent_offers_channels❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status. To learn more, visit the announcementhttps://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3. The first step for connectors to integrate with Offer Managementhttps://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors is to create a channel, that represents the marketplenvironment (string)
an (string) required
data: {
. vendor (string)
. name (string)
. logo (string)
} (object) required
marketplace_apis_sent_offers/post_api_sent_offers_feeds❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status. To learn more, visit the announcementhttps://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3. In Offer Managementhttps://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors, after creating the channelhttps://developers.vtex.com/docs/api-reference/marketplace-apis-offer-managemenvironment (string)
an (string) required
data: {
. id (string)
. affiliateId (string)
. SalesChannels (string)
} (object) required
marketplace_apis_sent_offers/get_api_sent_offers_feeds❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status. To learn more, visit the announcementhttps://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3. In Offer Managementhttps://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors, a feed is a list of information about seller's offers sent to a marketplace, and it is updatedenvironment (string)
an (string) required
marketplace_apis_sent_offers/put_api_sent_offers_feeds_by_feed_id❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status. To learn more, visit the announcementhttps://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3. In Offer Managementhttps://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors, a feed is a list of information about seller's offers sent to a marketplace. Once you have crenvironment (string)
feedId (string)
an (string) required
data: {
. affiliateId (string)
. salesChannels (string)
} (object) required
marketplace_apis_sent_offers/get_api_sent_offers_feeds_by_feed_id❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status. To learn more, visit the announcementhttps://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3. In Offer Managementhttps://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors, after you have created the channelhttps://developers.vtex.com/vtex-rest-api/reference/createchaenvironment (string)
feedId (string)
an (string) required
marketplace_apis_sent_offers/delete_api_sent_offers_feeds_by_feed_id❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status. To learn more, visit the announcementhttps://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3. In Offer Managementhttps://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors, a feed is a list of information about seller's offers sent to a marketplace. After creating a fenvironment (string)
feedId (string)
an (string) required
marketplace_apis_sent_offers/post_api_sent_offers_feeds_by_feed_id_skus_by_sku_id_interactions❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status. To learn more, visit the announcementhttps://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3. In Offer Managementhttps://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors, VTEX platform and marketplaces interact with offers through a medium called Interaction. For evenvironment (string)
feedId (string)
skuId (string)
an (string) required
data: {
. startDate (string)
. source (string)
. origin (string)
. context (string)
} (object) required
marketplace_apis_sent_offers/get_api_sent_offers_feeds_by_feed_id_skus_by_sku_id_interactions_by_interaction_id❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status. To learn more, visit the announcementhttps://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3. In Offer Managementhttps://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors, VTEX platform and marketplaces interact with offers through a medium called interactionhttps://environment (string)
feedId (string)
skuId (string)
interactionId (string)
an (string) required
marketplace_apis_sent_offers/post_api_sent_offers_feeds_by_feed_id_skus_by_sku_id_interactions_by_interaction_id_close❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status. To learn more, visit the announcementhttps://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3. In Offer Managementhttps://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors, VTEX platform and marketplaces interact with offers through a medium called interactionhttps://environment (string)
feedId (string)
skuId (string)
interactionId (string)
an (string) required
marketplace_apis_sent_offers/post_api_sent_offers_feeds_by_feed_id_skus_by_sku_id_interactions_by_interaction_id_logs❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status. To learn more, visit the announcementhttps://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3. In Offer Managementhttps://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors, logs are the granular details of actions that happen within an interactionhttps://developers.vtenvironment (string)
feedId (string)
skuId (string)
interactionId (string)
an (string) required
data: {
. description (string)
. date (string)
. type (string)
. agent (string)
. evidence
. data
. errors
} (object) required
marketplace_apis_sent_offers/get_api_sent_offers_feeds_by_feed_id_skus_by_sku_id_interactions_by_interaction_id_logs_by_log_id❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status. To learn more, visit the announcementhttps://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3. In Offer Managementhttps://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors, logs are the granular details of actions that happen within an interactionhttps://developers.vtenvironment (string)
feedId (string)
skuId (string)
interactionId (string)
logId (string)
an (string) required
marketplace_apis_sent_offers/get_api_sent_offers_search_interactions❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status. To learn more, visit the announcementhttps://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3. In Offer Managementhttps://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors, VTEX platform and marketplaces interact with offers through a medium called interactionhttps://environment (string)
an (string) required
q (string) required
channels (string)
brand (string)
category (string)
scope (string)
result (string)
sort (string) required
from (string) required
to (string) required
fromDate (string) required
toDate (string) required
marketplace_apis_sent_offers/get_api_sent_offers_search_errors❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status. To learn more, visit the announcementhttps://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3. This endpoint provides the single source of truth of updated error codes in Offer Management'shttps://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors configuration. It retenvironment (string)
an (string) required
q (string) required
channels (string) required
brand (string) required
category (string) required
errorCategory (string) required
sort (string) required
from (string) required
to (string) required
marketplace_apis_sent_offers/get_api_sent_offers_error_codes_by_error_code_id❗The Offer Management module has been discontinued and is no longer supported. The module has been replaced by Offer Status. To learn more, visit the announcementhttps://help.vtex.com/en/announcements/modulo-status-dos-anuncios-para-integracoes-com-marketplaces-vtex--1EeGgit1Brq3mmm8qhv2m3. This endpoint retrieves specific information about an error code in Offer Management'shttps://developers.vtex.com/vtex-rest-api/docs/sent-offers-integration-guide-connectors configuration. It provides thenvironment (string)
errorCodeId (string)
marketplace_apis_sent_offers/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
marketplace_apis_suggestions/get_suggestions_configuration_autoapproval_toggleThis endpoint can be used to check whether the autoapprove setting is active or not, for a specific seller. If the response is true, the autoapprove setting is active. If the response is false, it is inactive. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfulaccountName (string)
sellerId (string) required
Content-Type (string) required
Accept (string) required
marketplace_apis_suggestions/put_suggestions_configuration_autoapproval_toggleThis endpoint enables the autoapprove rule to a marketplace's whole Received SKUs module. Once enabling the rule, received SKUs will be automatically approved on your store, regardless of the seller. For the autoapprove rule to work as expected, the approval Matcher scorehttps://help.vtex.com/en/tutorial/entendendo-a-pontuacao-do-vtex-matcher--tutorials_424 should be set up as 80 default value, but you can configure a different number through the field Score in Save Account's Approval SettingaccountName (string)
Content-Type (string) required
Accept (string) required
data: {
. Enabled (boolean)
} (object) required
marketplace_apis_suggestions/get_suggestions_configurationThis endpoint retrieves the current approval settings of a marketplace's Received SKUs module. Its response includes: - Score: Matcher scores for approving and rejecting SKUs received from sellers. - Matchers: All Matchers configured on the marketplace, and their respective details. - SpecificationsMapping: Mapping of product and SKU specifications, per seller. - MatchFlux: This field determines the type of approval configuration applied to SKUs received from a seller. The possible valaccountName (string)
Content-Type (string) required
Accept (string) required
marketplace_apis_suggestions/put_suggestions_configurationMarketplaces use this endpoint to create or update approval settings on their Received SKUs module. The request includes all the details necessary to implement the chosen approval settings. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request.accountName (string)
Content-Type (string) required
Accept (string) required
data: {
. Score
. Matchers (array)
. SpecificationsMapping (array)
. MatchFlux (string)
} (object) required
marketplace_apis_suggestions/get_suggestions_configuration_account_configThis endpoint will be used by the marketplace to query the matcher's current approval settings on their incoming SKUs module. If the account has no matcher configured, the response will be 404 Not Found. For account approval configuration information, with response including specification information, see Get Account Approval Settingshttps://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions get-/suggestions/configuration terminal. The VTEX matcherhttps://help.vtex.com/pt/tuaccountName (string)
Content-Type (string) required
Accept (string) required
marketplace_apis_suggestions/get_suggestions_configuration_seller_by_seller_idThis endpoint retrieves the current Received SKUs approval settings applied to a specific seller. Its response includes: - sellerId: A string that identifies the seller in the marketplace. - accountId: Marketplace’s account ID. - accountName: Marketplace’s account name. - mapping: Mapping of SKU and product Specifications. - matchFlux: This field determines the type of approval configuration applied to SKUs received from a seller. The possible values include: -default, where theaccountName (string)
sellerId (string)
Content-Type (string) required
Accept (string) required
marketplace_apis_suggestions/put_suggestions_configuration_seller_by_seller_idMarketplaces use this endpoint to create or update approval settings to a specific seller, on the Received SKUs module. The request includes all the details necessary to implement the chosen approval settings. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfulaccountName (string)
sellerId (string)
Content-Type (string) required
Accept (string) required
data: {
. sellerId (string)
. mapping (object)
. matchFlux (string)
} (object) required
marketplace_apis_suggestions/put_suggestions_configuration_autoapproval_toggle_seller_by_seller_idThis endpoint enables the auto approve setting to received SKUs from a specific seller. Be aware that once enabling the rule through this request, all received SKUs from that seller will be automatically approved on your store, regardless of the Matcher Score. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resourcesaccountName (string)
sellerId (string)
Content-Type (string) required
Accept (string) required
data: {
. Enabled (boolean)
} (object) required
marketplace_apis_suggestions/get_suggestionsThis endpoint retrieves a list of all SKUs sent by the seller for the marketplace's approval. Marketplace operators should use this endpoint whenever they want to check the full list of received SKUs and their information. Note that all the information sent by the seller will be in the content object. All remaining information in this endpoint's response is given by the Matcher. Matcher rates received SKUs by correlating the data sent by sellers, to existing fields in the marketplace. The caccountName (string)
q (string)
type (string)
seller (string)
status (string)
hasmapping (string)
matcherid (string)
_from (integer)
_to (integer)
Content-Type (string) required
Accept (string) required
marketplace_apis_suggestions/put_suggestions_by_seller_id_by_seller_sku_idThis request is used by the seller when it wants to suggest that one of their SKUs is sold in the marketplace. Before using this request, the seller should always use the Change Notificationhttps://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-seller-sku-notification request in order to check if the SKU already exists in the marketplace. If it doesn't, then this is the next call in the SKU integration flow. In the Send Suggestion request, the seller must send information about thaccountName (string)
sellerId (string)
sellerSkuId (string)
Content-Type (string) required
Accept (string) required
data: {
. ProductName (string)
. ProductId (string)
. ProductDescription (string)
. BrandName (string)
. SkuName (string)
. SellerId (string)
. Height (integer)
. Width (integer)
. Length (integer)
. Weight (integer)
. RefId (string)
. EAN (string)
. SellerStockKeepingUnitId (integer)
. CategoryFullPath (string)
. SkuSpecifications (array)
. ProductSpecifications (array)
. Images (array)
. MeasurementUnit (string)
. UnitMultiplier (integer)
. AvailableQuantity (integer)
. Pricing (object)
} (object) required
marketplace_apis_suggestions/get_suggestions_by_seller_id_by_seller_sku_idThis endpoint retrieves the data of a specific SKU sent by the seller, to the marketplace. Marketplaces or external matchers can call this endpoint when they want to check the information about a single SKU. Note that all the information sent by the seller will be in the content object. All remaining information in this endpoint's response is given by the Matcher. Matcher rates received SKUs by correlating the data sent by sellers, to existing fields in the marketplace. The calculation of thaccountName (string)
sellerId (string)
sellerSkuId (string)
Content-Type (string) required
Accept (string) required
marketplace_apis_suggestions/delete_suggestions_by_seller_id_by_seller_sku_idThis endpoint deletes a chosen SKU suggestion. Only one SKU should be deleted per request. This action cannot be undone. A workaround to revert a deletion is to send the suggestion again, through the Send Suggestion API. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to saccountName (string)
sellerId (string)
sellerSkuId (string)
Content-Type (string) required
Accept (string) required
marketplace_apis_suggestions/get_suggestions_by_seller_id_by_sellerskuid_versionsWhenever a SKU suggestion is updated or changed, a new version of the original one is created. All versions are logged, so you can search for previous our current states of SKU suggestions. This endpoint retrieves the data of all previous and latest versions of a specific SKU suggestion, sent by the seller. Whenever a SKU is updated, it is important to map previous versions, to compare and identify changes. The response's object latestversion provides the information of the most recent versiaccountName (string)
sellerId (string)
sellerskuid (string)
Content-Type (string) required
Accept (string) required
marketplace_apis_suggestions/get_suggestions_by_seller_id_by_sellerskuid_versions_by_versionWhenever a SKU suggestion is updated or changed, a new version of the original one is created. All versions are logged, so you can search for previous our current states of SKU suggestions. This endpoint retrieves a specific version of a chosen SKU sent by the seller. Add the Seller's ID, Seller's SKU ID, and version ID in the path to detail your search. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of taccountName (string)
sellerId (string)
sellerskuid (string)
version (string)
Content-Type (string) required
Accept (string) required
marketplace_apis_suggestions/put_suggestions_by_seller_id_by_sellerskuid_versions_by_version_matches_by_matchidAll SKUs sent from a seller to a marketplace must be reviewed and matched. Actions in the matching process are added in the request body through the matchType object. Match type actions include: 1. newproduct: Match the SKU as a new product. 2. itemMatch: Associate the received SKU to an existing SKU. 3. productMatch: Associate the received SKU to an existing product. 4. deny: Deny the received SKU. 5. pending: The received SKU requires attention. 6. incomplete: The received SKU is laccountName (string)
sellerId (string)
sellerskuid (string)
version (string)
matchid (string)
Content-Type (string) required
Accept (string) required
data: {
. matcherId (string)
. matchType (string)
. score (string)
. skuRef (string)
. productRef (string)
. product
. sku
} (object) required
marketplace_apis_suggestions/put_suggestions_matches_action_by_action_nameAllows a marketplace to bulk approve, deny, or associate up to 25 received SKUs from sellers. Through the actionName attribute, you can select the operation you want to apply to the received SKU. Actions include: newproduct: Match the SKU as a new product. skuassociation: Associate the received SKU to an existing SKU. productassociation: Associate the received SKU to an existing product. deny: Deny the received SKU. Permissions Any user or API keyhttps://developers.vtex.comaccountName (string)
actionName (string)
Content-Type (string) required
Accept (string) required
data (array) required
marketplace_apis_suggestions/put_suggestions_configuration_by_seller_id_specificationsThis endpoint allows the seller to perform a bulk mapping of product specifications to the marketplace catalog. Specifications are additional properties that can be registered on products. To ensure this information is correctly interpreted, the marketplace must map the seller specifications to the corresponding fields in its own catalog. ⚠️ This process ensures that products sent by the seller contain data that matches the marketplace's catalog. Sending a new item without prior mapping daccountName (string)
sellerID (string)
Content-Type (string) required
Accept (string) required
data (object) required
marketplace_apis_suggestions/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
marketplace_apis/post_notificator_by_seller_id_changenotification_by_sku_id_priceThis endpoint is used by sellers to notify marketplaces that the price has changed for one of their SKUs. There is no request body in this call, indicating the new price value, for instance. It only notifies a specific marketplace accountName that a seller sellerId has changed the price of an SKU skuId. Marketplaces will then call the fulfillment endpointhttps://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation provided in the seller registration form to get the updatedaccountName (string)
environment (string)
sellerId (string)
skuId (string)
Accept (string) required
Content-Type (string) required
marketplace_apis/post_notificator_by_seller_id_changenotification_by_sku_id_inventoryThis endpoint is used by sellers to notify marketplaces that the inventory level has changed for one of their SKUs. There is no request body in this call, indicating the new inventory level, for instance. It only notifies a specific marketplace accountName that a seller sellerId has changed the inventory level of an SKU skuId. Marketplaces will then call the fulfillment endpointhttps://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation provided in the seller registration formaccountName (string)
environment (string)
sellerId (string)
skuId (string)
Accept (string) required
Content-Type (string) required
marketplace_apis/get_offer_manager_pvt_offersOffers are seller's products and SKUs that were sent to the marketplace, and already have their price and inventory level configured. This endpoint retrieves the available offers in a marketplace. It differs from the Get Suggestions endpoints, since it retrieves products that were already matched by the marketplace, and are currently in its catalog. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of theaccountName (string)
environment (string)
sort (string)
rows (integer)
start (integer)
fq (string)
Content-Type (string) required
Accept (string) required
marketplace_apis/get_offer_manager_pvt_product_by_product_id_sku_by_sku_idOffers are seller products and SKUs that were sent to the marketplace, and already have their price and inventory level configured. This endpoint retrieves the available offers for a speciic SKU ID in the marketplace's catalog. It differs from the Get Suggestionshttps://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions/ get-/suggestions endpoints, since it retrieves products that were already matched by the marketplace operator, and are currently active in its catalog. TheaccountName (string)
environment (string)
productId (string)
skuId (string)
Content-Type (string) required
Accept (string) required
marketplace_apis/get_offer_manager_pvt_product_by_product_idOffers are seller products and SKUs that were sent to the marketplace, and already have their price and inventory level configured. This endpoint retrieves the available offers for a speciic Product ID in the marketplace's catalog. It differs from the Get Suggestions endpoints, since it retrieves products that were already matched by the marketplace operator, and are currently active in its catalog. The call returns a list of offers for that ID, that contain the following data: - Seller thaccountName (string)
environment (string)
productId (string)
Content-Type (string) required
Accept (string) required
marketplace_apis/post_seller_register_pvt_seller_leadsThis API is used by marketplace operators to invite sellers to join their marketplace. The request sends an email to the seller, inviting sellers to activate their store. The invitation's link in the email is unique per user, and available for only seven days for the seller to click and begin activating their store. The email template is completely customizable. All email templates that VTEX sends to seller leads can be found and edited in the marketplace's VTEX Admin, on the Message Center seaccountName (string)
environment (string)
Accept (string) required
Content-Type (string) required
data: {
. sellerEmail (string)
. sellerName (string)
. sellerAccountName (string)
. salesChannel (string)
. email (string)
. sellerType (integer)
. accountId (string)
. document (string)
. hasAcceptedLegalTerms (boolean)
. address
. accountable
} (object) required
marketplace_apis/get_seller_register_pvt_seller_leadsThis call's response includes a list of all sellers invited by the marketplace operator to join them. Retrieved results can be filtered by adding optional query fields to the request. Each seller listed includes the following information: - id - createdAt - status - isConnected - sellerEmail - sellerName - salesChannel - email Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriateaccountName (string)
environment (string)
offset (integer) required
limit (integer) required
isConnected (string) required
search (string) required
status (string) required
orderBy (string) required
Accept (string) required
Content-Type (string) required
marketplace_apis/put_seller_register_pvt_seller_leads_by_seller_lead_idThis endpoint is triggered by the seller onboarding wizard, once the seller confirms their invitation. It can be used by marketplace operators to manually accept seller leads, and carry on with their onboarding process. Note that there's no specific API call that allows status changes. The operations only allow the seller lead to move forward: From invite to Accept closing on Create sellerhttps://developers.vtex.com/docs/api-reference/marketplace-apis/ put-/seller-register/pvt/seller-leadaccountName (string)
environment (string)
sellerId (string)
sellerLeadId (string)
Content-Type (string) required
data: {
. sellerEmail (string)
. sellerName (string)
. sellerAccountName (string)
. salesChannel (string)
. email (string)
. sellerType (integer)
. accountId (string)
. document (string)
. hasAcceptedLegalTerms (boolean)
. address
. accountable
} (object) required
marketplace_apis/get_seller_register_pvt_seller_leads_by_seller_lead_idMarketplace operators may call this endpoint to retrieve information about a specific seller invited to the Seller Portal, by searching through their seller lead ID. To retrieve the chosen seller's sellerLeadId, marketplace operators can use the List Sellershttps://developers.vtex.com/docs/api-reference/marketplace-apis get-/seller-register/pvt/sellers?endpoint=get-/seller-register/pvt/sellers endpoint's response. Each seller listed includes the following information: - id - createdAt - staccountName (string)
environment (string)
sellerId (string)
sellerLeadId (string)
Accept (string) required
Content-Type (string) required
marketplace_apis/delete_seller_register_pvt_seller_leads_by_seller_lead_idThis endpoint permanently deletes a seller previously invited to the marketplace, only if the seller has not yet accepted the invitation. For sellers who have already accepted the invitation, it is only possible to pause the sellerhttps://help.vtex.com/en/tutorial/gerenciamento-de-sellers--6eEiOISwxuAWJ8w6MtK7iv through the VTEX Admin. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate LicenaccountName (string)
environment (string)
sellerLeadId (string)
Accept (string) required
Content-Type (string) required
marketplace_apis/put_seller_register_pvt_seller_leads_by_seller_lead_id_sellerThis endpoint is used by marketplace operators to create seller accounts. The request will only accept seller leads whose status is accepted. If they are already connected or invited, the call will not be fulfilled. ❗ The creation of the account at VTEX is done by an internal Billing service. There is no seller account and marketplace affiliation if you do not go through this step. Note that there's no specific API call that allows status changes. The operations only allow the seller lead taccountName (string)
environment (string)
sellerId (string)
sellerLeadId (string)
isActive (boolean)
Accept (string) required
Content-Type (string) required
marketplace_apis/put_seller_register_pvt_seller_leads_by_seller_lead_id_statusThis endpoint allows marketplace operators to resend an invitation to a seller lead who was previously invited to join their marketplace. The request will only accept seller leads whose status is invited. If they are already connected or accepted, the call will not be fulfilled. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/liceaccountName (string)
environment (string)
sellerId (string)
sellerLeadId (string)
Accept (string) required
Content-Type (string) required
data: {
. status (string)
} (object) required
marketplace_apis/get_seller_register_pvt_sellers_by_seller_id_commissionsThis endpoint retrieves all comissions configured for a specific seller. It is not necessary to send a request body. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicaccountName (string)
environment (string)
sellerId (string)
Accept (string) required
Content-Type (string) required
marketplace_apis/put_seller_register_pvt_sellers_by_seller_id_commissionsThis endpoint is used by marketplace operators to define comissions for multiple categories, sending an array with multiple objects in the same call. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status codaccountName (string)
environment (string)
sellerId (string)
Accept (string) required
Content-Type (string) required
data (array) required
marketplace_apis/delete_seller_register_pvt_sellers_by_seller_id_commissions_by_category_idThis endpoint removes a seller comission on the selected category. ❗This action cannot be undone, to reconfigure the commission it is necessary to use the Upsert Seller Commissions in Bulk endpointhttps://developers.vtex.com/docs/api-reference/marketplace-apis put-/seller-register/pvt/sellers/-sellerId-/commissions/categories?endpoint=put-/seller-register/pvt/sellers/-sellerId-/commissions/categories. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authenaccountName (string)
environment (string)
sellerId (string)
categoryId (string)
Accept (string) required
Content-Type (string) required
marketplace_apis/get_seller_register_pvt_sellers_by_seller_id_commissions_by_category_idThis endpoint retrieves seller comissions applied to the selected category. It is not necessary to send a request body. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the appaccountName (string)
environment (string)
sellerId (string)
categoryId (string)
marketplace_apis/post_seller_register_pvt_sellersThis endpoint is used by marketplace operators to configure the accounts of sellers that have already accepted the invitation to join their marketplaces. For marketplaces to add sellershttps://help.vtex.com/en/tutorial/adding-a-seller--tutorials_392 without the Seller Invitehttps://help.vtex.com/en/tutorial/marketplace-invited-sellers--6rb2FkcslmDueJ689Ulb9A feature, call this endpoint directly. This call includes all the information a seller needs to activate their account. PermissioaccountName (string)
environment (string)
Accept (string) required
Content-Type (string) required
data: {
. id (string)
. name (string)
. isActive (boolean)
. fulfillmentEndpoint (string)
. allowHybridPayments (boolean)
. taxCode (string)
. email (string)
. description (string)
. sellerCommissionConfiguration (object)
. isBetterScope (boolean)
. sellerType (integer)
. availableSalesChannels (array)
. CSCIdentification (string)
. account (string)
. channel (string)
. salesChannel (string)
. isVtex (boolean)
. exchangeReturnPolicy (string)
. deliveryPolicy (string)
. securityPrivacyPolicy (string)
. fulfillmentSellerId (string)
. groups (array)
. user (string)
. password (string)
. catalogSystemEndpoint (string)
. trustPolicy (string)
. score (number)
} (object) required
marketplace_apis/get_seller_register_pvt_sellersThis endpoint lists all sellers. The results can be filtered by trade policieshttps://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV through the sc query param. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. OaccountName (string)
environment (string)
from (number)
to (number)
keyword (string)
integration (string)
group (string)
isActive (boolean)
isBetterScope (boolean)
isVtex (boolean)
sc (string)
sellerType (integer)
sort (string)
Accept (string) required
Content-Type (string) required
marketplace_apis/patch_seller_register_pvt_sellers_by_seller_idThis endpoint allows marketplace operators to update the information of sellers connected to their account. You can replace a path's value with another value in order to update that single information. There is no need to fill all the body params available, only the one you wish to update. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tuaccountName (string)
environment (string)
sellerId (string)
Accept (string) required
Content-Type (string) required
data (array) required
marketplace_apis/get_seller_register_pvt_sellers_by_seller_idMarketplace operators may call this endpoint to retrieve information about a specific seller by filtering by ID. It is also possible to filter results by sales channel trade policyhttps://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV through the sc query param. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutaccountName (string)
environment (string)
sellerId (string)
sc (string)
Accept (string) required
Content-Type (string) required
marketplace_apis/put_seller_register_pvt_sellers_by_seller_id_sales_channel_mappingThis endpoint allows the marketplace to map its trade policieshttps://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV with a seller's affiliatehttps://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187. A seller can have multiple trade policieshttps://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV associated with the same marketplace, creating different affiliates. The mapping allows the seller to segment catalog, pricing, inventoaccountName (string)
environment (string)
sellerId (string)
Content-Type (string) required
Accept (string) required
an (string) required
data (array) required
marketplace_apis/get_seller_register_pvt_sellers_by_seller_id_sales_channel_mappingRetrieves information about the mapping between marketplace's sales channels and a specific seller. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources faccountName (string)
environment (string)
sellerId (string)
Content-Type (string) required
Accept (string) required
an (string) required
marketplace_apis/get_fulfillment_pvt_affiliatesLists all affiliatehttps://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187 configurations in a store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the appliaccountName (string)
environment (string)
Accept (string) required
Content-Type (string) required
marketplace_apis/get_fulfillment_pvt_affiliates_by_affiliate_idRetrieves the specified affiliatehttps://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187 configuration by affiliate ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. TaffiliateId (string)
accountName (string)
environment (string)
Accept (string) required
Content-Type (string) required
marketplace_apis/put_fulfillment_pvt_affiliates_by_affiliate_idUpdates the affiliatehttps://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187 configuration by ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicablaffiliateId (string)
accountName (string)
environment (string)
Accept (string) required
Content-Type (string) required
data: {
. followUpEmail (string)
. useSellerPaymentMethod (boolean)
. name (string)
. salesChannel (string)
. searchURIEndpoint (string)
. searchURIEndpointVersion (string)
. searchURIEndpointAvailableVersions (array)
. minimumValueAccumulated (integer)
} (object) required
marketplace_apis/delete_fulfillment_pvt_affiliates_by_affiliate_idDeletes the specified affiliatehttps://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187 configuration by ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are theaffiliateId (string)
accountName (string)
environment (string)
Accept (string) required
Content-Type (string) required
marketplace_apis/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
marketplace_protocol_external_marketplace_mapper/get_api_channel_manager_channel_allThis request returns a list of channels available channels with their respective IDs for partners external to VTEX. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.enviroment (string)
an (string) required
marketplace_protocol_external_marketplace_mapper/get_api_channel_manager_channel_channel_idRetrieves a specific channel that already exists in Channel Manager. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.enviroment (string)
channelId (number)
an (string) required
marketplace_protocol_external_marketplace_mapper/post_api_mkp_category_mapper_connector_registerMapped 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 shoan (string) required
data: {
. displayName (string)
. categoryTreeEndPoint (string)
. mappingEndPoint (string)
. properties (object)
. CategoryTreeProcessingNotificationEndpoint (string)
} (object) required
marketplace_protocol_external_marketplace_mapper/post_api_mkp_category_mapper_categories_marketplace_by_idMapping 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 aid (string)
data: {
. categories (array)
} (object) required
marketplace_protocol_external_marketplace_mapper/post_api_channel_manager_connectorRegisters 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. Possible values for field type: - APP, if using our App Template. - EXTERNAL, if not using App Template. Possible values for field segment: - ADS - APPAREL_ACCESSORIES - BEAUTY_HEALTH - BOOKS_EDUCATION - CARS_AUTOPARTS - DEPARTMENT_STORES - ELETRONICS - FINANCIAL_INSenvironment (string)
an (string) required
data (undefined) required
marketplace_protocol_external_marketplace_mapper/get_api_channel_manager_connector_allReturns a paginated list of all connectors' registered in Channel Manager, taking into consideration the filters informed in the query string of the request. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.environment (string)
an (string) required
segment (string)
orderByConnectorType (string)
active (string)
name (string)
page (integer)
pageSize (integer) required
country (string)
type (string)
account (string)
marketplace_protocol_external_marketplace_mapper/get_api_channel_manager_connector_connector_idRetrieve a specific connector registered in VTEX platform.environment (string)
connectorId (integer)
an (string) required
marketplace_protocol_external_marketplace_mapper/post_api_channel_manager_connector_connector_idReceives an event describing a connection update between the connector with the specified ID and the merchant specified in the query string./n/rThis information is used in the list all connectors route: the account name will be used to return the isConnectionActive and affiliateId fields.environment (string)
connectorId (integer)
an (string) required
data: {
. isActive (boolean)
. affiliateId (string)
} (object) required
marketplace_protocol_external_marketplace_mapper/delete_api_channel_manager_connector_connector_idRemoves a connector from VTEX platform. This action can only be executed by the account name that owns the connector's registration.environment (string)
connectorId (number)
an (string) required
marketplace_protocol_external_marketplace_mapper/put_api_channel_manager_connector_connector_idFully 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.environment (string)
connectorId (number)
an (string) required
data: {
. name (string)
. website (string)
. logo (string)
. description (string)
. segment (string)
. availableCountries (array)
. connectorVtexAdminPath (string)
. connectorApiEndpoint (string)
} (object) required
marketplace_protocol_external_marketplace_mapper/patch_api_channel_manager_connector_connector_idPartially 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.environment (string)
connectorId (number)
an (string) required
data: {
. path (string)
. op (string)
. value (string)
} (object) required
marketplace_protocol_external_marketplace_mapper/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
marketplace_protocol_external_marketplace_orders/post_api_fulfillment_pvt_ordersCreates fulfillment order, meaning that it is an order for the seller's side in a sale made through a marketplace. This order assumes the transaction itself has already happened on the marketplace's side and, therfore, cares only about the fulfillment side. If you plan to integrate external orders with possible Price divergencehttps://help.vtex.com/en/tutorial/price-divergence-rule--6RlFLhD1rIRRshl83KnCjW be mindful of the isCreatedAsync request body field. For a detailed explanation of taccountName (string)
environment (string)
sc (string)
affiliateId (string) required
data: {
. marketplaceOrderId (string)
. marketplaceServicesEndpoint (string)
. marketplacePaymentValue (integer)
. isCreatedAsync (boolean)
. items (array)
. clientProfileData (object)
. shippingData (object)
. paymentData (object)
. marketingData (object)
. openTextField (string)
} (object) required
marketplace_protocol_external_marketplace_orders/post_api_fulfillment_pvt_orders_by_order_id_fulfillCreates fulfillment order, meaning that it is an order for the seller's side in a sale made through a marketplace. This order assumes the transaction itself has already happened on the marketplace's side and, therfore, cares only about the fulfillment side. 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 Guidehttps://developers.vtex.com/vtex-rest-api/docs/eaccountName (string)
environment (string)
orderId (string)
sc (string)
affiliateId (string) required
data: {
. marketplaceOrderId (string)
} (object) required
marketplace_protocol_external_marketplace_orders/post_api_order_integration_ordersAPI to integrate an external channel's order into the VTEX plataform. This process is asynchronous and a notification with the order's integration results will be sent to the endpoint specified in the connectorEndpoint field in App Templatehttps://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-app-template, if the connector uses our App template. The field connectorName is also optional for connectors that use our App Template and authenticate using the app's auth cookiaccountName (string)
an (string)
affiliateId (string) required
data: {
. marketplaceOrderId (string)
. connectorName (string)
. connectorEndpoint (string)
. marketplaceOrderStatus (string)
. marketplacePaymentValue (integer)
. marketplaceInterestValue (integer)
. priceDivergenceAllowanceRate (number)
. allowFranchises (boolean)
. pickupAccountName (string)
. items (array)
. clientProfileData
. shippingData
. invoiceData
. customData
. taxData (array)
. openTextField (string)
} (object) required
marketplace_protocol_external_marketplace_orders/put_api_order_integration_orders_statusAPI request used to update an order status in VTEX. This process is asynchronous and a notification with the order's integration results will be sent to the endpoint specified in the connectiorEndpoint field or the connectiorEndpoint App Templatehttps://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-app-template, if the connector uses our App template. The field connectorName is also optional for connectors that use our App Template and authenticate using the app's authaccountName (string)
an (string)
data: {
. marketplaceOrderId (string)
. marketplaceOrderStatus (string)
. connectorName (string)
. connectorEndpoint (string)
} (object) required
marketplace_protocol_external_marketplace_orders/post_api_checkout_pub_order_forms_simulationThis endpoint can be triggered by marketplaces to simulate the fulfillment of an item in the cart. The fulfillment information is useful whenever you need to know the availability of fulfilling an order for a specific cart setting, since the API response will let you know the updated price, inventory and shipping data. Permissions Check with your service provider to know what permissions are needed.accountName (string)
environment (string)
affiliateId (string)
sc (integer)
data: {
. items (array)
. marketingData (object)
. postalCode (string)
. country (string)
. selectedSla (string)
. clientProfileData (object)
. geoCoordinates (array)
. isCheckedIn (boolean)
. storeId (string)
} (object) required
marketplace_protocol_external_marketplace_orders/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
marketplace_protocol_external_seller_fulfillment/post_pvt_order_forms_simulationThis endpoint may be called upon by VTEX for fulfillment simulation in the external seller different contexts. See examples below. When a pricehttps://developers.vtex.com/docs/api-reference/marketplace-apis post-/notificator/-sellerId-/changenotification/-skuId-/price or inventoryhttps://developers.vtex.com/docs/api-reference/marketplace-apis post-/notificator/-sellerId-/changenotification/-skuId-/inventory notification request returns a response with status 200 OK, it means that the SKU alreadfulfillmentEndpoint (string)
Accept (string) required
Content-Type (string) required
data: {
. postalCode (string)
. geoCoordinates (array)
. country (string)
. items (array)
. sc (string)
} (object) required
marketplace_protocol_external_seller_fulfillment/post_pvt_ordersThis request is sent by VTEX to the external seller once the customer finishes their checkout, to let the seller know there is a newly placed order. It does that by calling the Order Placement endpoint, which needs to be implemented by the seller. The marketplace will send information such as the items contained in the cart, the client’s profile data, the shipping data, and the payment data. With all that, the seller will be able to create the order in their store. Permissions Any userfulfillmentEndpoint (string)
content-length (string) required
authorization (string) required
Accept (string) required
accept-enconding (string) required
x-vtex-operation-id (string) required
x-forwarded-proto (string) required
x-forwarded-for (string) required
x-vtex-cache-client-bypass (string) required
Content-Type (string) required
traceparent (string) required
data: {
. marketplaceOrderId (string)
. marketplaceServicesEndpoint (string)
. marketplacePaymentValue (integer)
. items (array)
. paymentData (object)
. clientProfileData (object)
. shippingData (object)
. marketingData (object)
. openTextField (string)
} (object) required
marketplace_protocol_external_seller_fulfillment/post_pvt_orders_by_seller_order_id_fulfillThis request is sent from VTEX to the seller after the payment is approved, to notify them that the fulfillment process can start. Permissions Check with your service provider to know what permissions are needed.fulfillmentEndpoint (string)
sellerOrderId (string)
Accept (string) required
Content-Type (string) required
data: {
. marketplaceOrderId (string)
. marketplaceOrderGroup (string)
. cancellationRequestId (string)
. cancellationRequestDate (string)
. reason (string)
. requestedByUser (boolean)
. paymentData (object)
} (object) required
marketplace_protocol_external_seller_fulfillment/post_pvt_orders_by_order_id_cancelThis request may be sent from VTEX to the external seller in case of order cancelation. For that, the seller will need to implement the Marketplace order cancellation endpoint. Whenever this request is received by the seller, the order should be canceled and the fulfillment flow should not proceed. For the seller to: - Evaluate a cancellation request: it is possible to send an empty body as a response to the cancellation request, meaning that the seller is evaluating whether to proceed withfulfillmentEndpoint (string)
orderId (string)
Accept (string) required
Content-Type (string) required
data: {
. marketplaceOrderId (string)
. marketplaceOrderGroup (string)
. cancellationRequestId (string)
. cancellationRequestDate (string)
. reason (string)
. requestedByUser (boolean)
. paymentData (object)
} (object) required
marketplace_protocol_external_seller_fulfillment/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
marketplace_protocol_external_seller_marketplace/post_pvt_orders_by_marketplace_order_id_invoiceThis request is sent by the external seller to the VTEX marketplace to send invoice information. This can be necessary in a regular order or in the case of a return. The type field is used to indicate which of these is the case. Permissions Check with your service provider to know what permissions are needed.marketplaceOrderId (string)
marketplaceServicesEndpoint (string)
invoiceNumber (string)
Accept (string) required
Content-Type (string) required
data: {
. type (string)
. invoiceNumber (string)
. courier (string)
. trackingNumber (string)
. trackingUrl (string)
. items (array)
. issuanceDate (string)
. invoiceValue (integer)
} (object) required
marketplace_protocol_external_seller_marketplace/post_pvt_orders_by_marketplace_order_id_invoice_by_invoice_numberThis request is sent by the external seller to the VTEX marketplace to add tracking information to a given order's invoice, in case it is necessary to do so after the invoice has been sent. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request.marketplaceServicesEndpoint (string)
marketplaceOrderId (string)
invoiceNumber (string)
Accept (string) required
Content-Type (string) required
data (undefined) required
marketplace_protocol_external_seller_marketplace/post_pvt_orders_by_marketplace_order_id_invoice_by_invoice_number_trackingThis request is sent by the external seller to the VTEX marketplace to update a given order's tracking status. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable rmarketplaceServicesEndpoint (string)
marketplaceOrderId (string)
invoiceNumber (string)
Accept (string) required
Content-Type (string) required
data: {
. isDelivered (boolean)
. events (array)
} (object) required
marketplace_protocol_external_seller_marketplace/post_pvt_orders_by_marketplace_order_id_cancelThis request is sent by the external seller to the VTEX marketplace to cancel an order. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, they will receive a status code 403 error. These are the applicable resources for this endpmarketplaceServicesEndpoint (string)
marketplaceOrderId (string)
Accept (string) required
Content-Type (string) required
data: {
. reason (string)
} (object) required
marketplace_protocol_external_seller_marketplace/post_pvt_orders_by_participant_order_id_changes_by_change_request_id_send_agreementThis endpoint sends an agreement for an order modification to VTEX. It can be used by external sellers to acknowledge that a modification request was made and confirm that the modification has been applied to their order. After a shopper requests a modification, VTEX automatically calls the external seller through the new client, sending a request to the Create order modificationshttps://developers.vtex.com/docs/api-reference/orders-api patch-/api/order-system/orders/-changeOrderId-/changesorderId (string)
changeId (string)
participantOrderId (string)
changeRequestId (string)
accountName (string) required
Accept (string) required
Content-Type (string) required
data: {
. agreementType (string)
} (object) required
marketplace_protocol_external_seller_marketplace/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
master_data_api_v2/post_api_dataentities_by_data_entity_name_documentsCreates a new document with an ID automatically generated by VTEX, corresponding to a new or existing data entity. If an unexisting dataEntityName is informed in the path, this endpoint will create the data entity as well as the new document. For example, you can create a new customer profile or address. ℹ️ You can use this request to create documents for any data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. However you should be awardataEntityName (string)
Content-Type (string) required
Accept (string) required
_schema (string)
data (object) required
master_data_api_v2/patch_api_dataentities_by_data_entity_name_documentsThis request allows you to partially update a document corresponding to a given data entity. ℹ️ You can use this request to create documents for any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least onedataEntityName (string)
_schema (string)
Content-Type (string) required
Accept (string) required
data (object) required
master_data_api_v2/get_api_dataentities_by_data_entity_name_documents_by_idRetrieves a document by ID. ℹ️ Assign the _fields parameter in the query string to retrieve the desired fields. If you want to return all the fields use _fields=_all. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they willdataEntityName (string)
id (string)
Content-Type (string) required
Accept (string) required
_fields (string)
_schema (string)
master_data_api_v2/put_api_dataentities_by_data_entity_name_documents_by_idCreates a new document with a custom ID, or updates an entire document if there is already a document with the informed ID. For example, you can update a customer profile or address. ℹ️ You can use this request to create or update documents in any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update. A Permissions Any user or APIdataEntityName (string)
id (string)
_where (string)
_schema (string)
Accept (string) required
data (object) required
master_data_api_v2/patch_api_dataentities_by_data_entity_name_documents_by_idThis request allows you to partially update a document corresponding to a given data entity. For example, you can update some fields of a customer profile or address. ℹ️ You can use this request to update documents for any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update. Permissions Any user or API keyhttps://developers.vtexdataEntityName (string)
id (string)
_where (string)
_schema (string)
Accept (string) required
data (object) required
master_data_api_v2/delete_api_dataentities_by_data_entity_name_documents_by_idDeletes a document. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --------------- | ----dataEntityName (string)
id (string)
Content-Type (string) required
Accept (string) required
master_data_api_v2/get_api_dataentities_by_data_entity_name_searchRetrieves Master Data v2 documents' information, while choosing which fields will be returned and filtering documents by specific fields. The response header REST-Content-Range indicates the total amount of results for that specific search. For example, it may return resources 0-100/136108, which indicates it has returned the first 100 results out of a total of 136108. Below you can see some query examples and learn more about each query parameter. Learn more about Pagination in the MadataEntityName (string)
Content-Type (string) required
Accept (string) required
REST-Range (string) required
_fields (string)
_where (string)
_schema (string)
_sort (string)
master_data_api_v2/get_api_dataentities_by_data_entity_name_scrollReturns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint. In the first request, the X-VTEX-MD-TOKEN token will be obtained in the response header. This token must be passed to the next request in the _token query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer. After the token idataEntityName (string)
Content-Type (string) required
Accept (string) required
_token (string)
_size (integer)
_fields (string)
_where (string)
_schema (string)
_sort (string)
master_data_api_v2/get_api_dataentities_by_data_entity_name_schemasRetrieves all existing schemashttps://developers.vtex.com/docs/guides/master-data-schema-lifecycle for a given data entity. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are thdataEntityName (string)
Content-Type (string) required
master_data_api_v2/get_api_dataentities_by_data_entity_name_schemas_by_schema_nameReturns an existing schemahttps://developers.vtex.com/docs/guides/master-data-schema-lifecycle for a given data entity. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the apdataEntityName (string)
schemaName (string)
Content-Type (string) required
master_data_api_v2/put_api_dataentities_by_data_entity_name_schemas_by_schema_nameCreates or edits a data entity schema. Learn more about Master Data schemashttps://developers.vtex.com/vtex-rest-api/docs/master-data-schema-lifecycle. Note that if you send a schemaName that does not exist for that data entity, this request will create it. This request can also be used to create or edit Master Data v2 triggershttps://developers.vtex.com/vtex-rest-api/docs/setting-up-triggers-in-master-data-v2. Each Master Data v2 data entity can have up to 60 schemas. IndexingdataEntityName (string)
schemaName (string)
data: {
. properties (object)
. v-indexed (array)
} (object) required
master_data_api_v2/delete_api_dataentities_by_data_entity_name_schemas_by_schema_nameDeletes an existing schemahttps://developers.vtex.com/docs/guides/master-data-schema-lifecycle for a given data entity. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the apdataEntityName (string)
schemaName (string)
Content-Type (string) required
master_data_api_v2/get_api_dataentities_by_data_entity_name_indicesReturns the list of indiceshttps://developers.vtex.com/docs/guides/master-data-components index by data entity. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicabledataEntityName (string)
Content-Type (string) required
master_data_api_v2/put_api_dataentities_by_data_entity_name_indicesCreates an indexhttps://developers.vtex.com/docs/guides/master-data-components index. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoidataEntityName (string)
data: {
. name (string)
. multiple (boolean)
. fields (string)
} (object) required
master_data_api_v2/get_api_dataentities_by_data_entity_name_indices_by_index_nameRetrieves an indexhttps://developers.vtex.com/docs/guides/master-data-components index. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpdataEntityName (string)
index_name (string)
Content-Type (string) required
master_data_api_v2/delete_api_dataentities_by_data_entity_name_indices_by_index_nameDeletes an indexhttps://developers.vtex.com/docs/guides/master-data-components index. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoidataEntityName (string)
index_name (string)
Content-Type (string) required
master_data_api_v2/post_api_dataentities_by_data_entity_name_documents_by_id_clustersChecks if a document is present in one or more clusters specific set of field values. ℹ️ There is a limit of five rules per request. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error.dataEntityName (string)
id (string)
Accept (string) required
data (array) required
master_data_api_v2/get_api_dataentities_by_data_entity_name_documents_by_id_versionsLists the versions of a document. ℹ Master Data documents are versioned. This means that, for each change, a new version is generated. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 errodataEntityName (string)
id (string)
Content-Type (string) required
Accept (string) required
load (boolean)
fields (string)
master_data_api_v2/get_api_dataentities_by_data_entity_name_documents_by_id_versions_by_version_idReturns the version of a document. ℹ Master Data documents are versioned. This means that, for each change, a new version is generated. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 errdataEntityName (string)
id (string)
versionId (string)
Content-Type (string) required
Accept (string) required
master_data_api_v2/put_api_dataentities_by_data_entity_name_documents_by_id_versions_by_version_idUpdates the document's version value. ℹ Master Data documents are versioned. This means that, for each change, a new version is generated. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 edataEntityName (string)
id (string)
versionId (string)
Content-Type (string) required
Accept (string) required
master_data_api_v2/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
masterdata_api_v10_2/get_api_dataentitiesRetrieves the list of existing data entities in the store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategoryContent-Type (string) required
Accept (string) required
masterdata_api_v10_2/get_api_dataentities_by_acronymReturns the data entity structure with its respective fields and data type. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Pacronym (string)
Content-Type (string) required
Accept (string) required
masterdata_api_v10_2/post_api_dataentities_by_acronym_documentsCreates a new document with an ID automatically generated by VTEX, corresponding to a given data entity. The request body is a JSON object where the key is the name of the field. ⚠️ Do not use Master Data as a log, cache, or temporary data store. Writing high volumes of disposable data can trigger API throttling and degrade store performance. ℹ️ You can use this request to create documents in any given data entity. Because of this, you are not restricted to using the fields exemplified belacronym (string)
Content-Type (string) required
Accept (string) required
data: {
. fieldName (string)
} (object) required
masterdata_api_v10_2/patch_api_dataentities_by_acronym_documentsCreates a partial document, sending only some of the fields. You can use this request to create documents in any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manageracronym (string)
Content-Type (string) required
Accept (string) required
data: {
. id (string)
. fieldName (string)
} (object) required
masterdata_api_v10_2/get_api_dataentities_by_acronym_documents_by_idRetrieves a document. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --------------- | ---acronym (string)
id (string)
Content-Type (string) required
Accept (string) required
_fields (string)
masterdata_api_v10_2/put_api_dataentities_by_acronym_documents_by_idCreates a new document with a custom ID, or updates an entire document if there is already a document with the informed ID. ℹ️ You can use this request to create or update documents in any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update. Custom field types The table below presents the types of custom fields you can use whenacronym (string)
id (string)
Content-Type (string) required
Accept (string) required
data: {
. fieldName (string)
} (object) required
masterdata_api_v10_2/patch_api_dataentities_by_acronym_documents_by_idUpdates a subset of fields of a document, without impacting the other fields. ℹ️ You can use this request to update documents in any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriacronym (string)
id (string)
Content-Type (string) required
Accept (string) required
data (object) required
masterdata_api_v10_2/delete_api_dataentities_by_acronym_documents_by_idDeletes a document. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --------------- | ----acronym (string)
id (string)
Content-Type (string) required
Accept (string) required
masterdata_api_v10_2/get_api_dataentities_by_acronym_documents_by_id_versionsLists all versions of a document. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --------acronym (string)
id (string)
Content-Type (string) required
Accept (string) required
masterdata_api_v10_2/get_api_dataentities_by_acronym_documents_by_id_versions_by_version_idReturns the version of a document. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -------acronym (string)
id (string)
versionId (string)
Content-Type (string) required
Accept (string) required
masterdata_api_v10_2/put_api_dataentities_by_acronym_documents_by_id_versions_by_version_idUpdates the version of a document. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -------acronym (string)
id (string)
versionId (string)
Content-Type (string) required
Accept (string) required
masterdata_api_v10_2/get_api_dataentities_by_acronym_scrollReturns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint. In the first request, the X-VTEX-MD-TOKEN token will be obtained in the response header. This token must be passed to the next request in the _token query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer. After the token iacronym (string)
Content-Type (string) required
Accept (string) required
_fields (string)
_where (string)
_sort (string)
_size (string)
_token (string)
masterdata_api_v10_2/get_api_dataentities_by_acronym_searchRetrieves Master Data v1 documents' information, while choosing which fields will be returned and filtering documents by specific fields. ℹ️ Learn more about Pagination in the Master Data APIhttps://developers.vtex.com/docs/guides/pagination-in-the-master-data-api and Querying documents in Master Data v1https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1. Query examples | Filter Type | Example | |-|-| | Simple filter | /dataentities/CL/search?email=my@emaacronym (string)
Content-Type (string) required
Accept (string) required
REST-Range (string) required
_fields (string)
_where (string)
_sort (string)
masterdata_api_v10_2/get_api_dataentities_by_acronym_documents_by_id_by_field_attachments_by_file_nameRetrieves a file that had been previously saved in a field of type File. ⚠️ Make sure to include the file extension in the name, like in this example: /api/dataentities/CL/documents/123/file/attachments/image.png. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to sucacronym (string)
id (string)
field (string)
file-name (string)
Content-Type (string) required
Accept (string) required
masterdata_api_v10_2/post_api_dataentities_by_acronym_documents_by_id_by_field_attachmentsSaves a file in a field of type File. Learn more about Data entity field typeshttps://help.vtex.com/en/tutorial/creating-data-entity--tutorials_1265 understanding-the-types. You can upload more than one file. Just add a new field in the form-data with type File. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-racronym (string)
id (string)
field (string)
Content-Type (string) required
Accept (string) required
masterdata_api_v10_2/post_api_dataentities_by_acronym_documents_by_id_clustersValidate documents by clusters. Learn more about Master Data clustershttps://help.vtex.com/en/tutorial/how-can-i-create-cluster-of-customers--frequentlyAskedQuestions_1724. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise thacronym (string)
id (string)
Content-Type (string) required
Accept (string) required
data (array) required
masterdata_api_v10_2/put_api_dataentities_by_acronym_documents_by_id_scoreUpdates the score of more than one Score2 type field and more than one key. Learn more about Data entity field typeshttps://help.vtex.com/en/tutorial/creating-data-entity--tutorials_1265 understanding-the-types. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfacronym (string)
id (string)
Content-Type (string) required
Accept (string) required
data (array) required
masterdata_api_v10_2/put_api_dataentities_by_acronym_documents_by_id_score_by_field_nameUpdates the score of a specific Score2 type field. Learn more about Data entity field typeshttps://help.vtex.com/en/tutorial/creating-data-entity--tutorials_1265 understanding-the-types. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otacronym (string)
id (string)
field-name (string)
Content-Type (string) required
Accept (string) required
data: {
. key (string)
. point (integer)
. until (string)
} (object) required
masterdata_api_v10_2/delete_api_dataentities_by_acronym_documents_by_id_score_by_field_nameRemoves a key from a specific Score2 type field. Learn more about Data entity field typeshttps://help.vtex.com/en/tutorial/creating-data-entity--tutorials_1265 understanding-the-types. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otheacronym (string)
id (string)
field-name (string)
Content-Type (string) required
Accept (string) required
data: {
. key (string)
} (object) required
masterdata_api_v10_2/post_api_dataentities_cl_documentsCreates new customer profile. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -------------Content-Type (string) required
Accept (string) required
_schema (string)
data: {
. email (string)
. firstName (string)
. lastName (string)
. phone (string)
. documentType (string)
. document (string)
. isCorporate (boolean)
. isNewsletterOptIn (boolean)
. localeDefault (string)
. corporateDocument (string)
. homePhone (string)
. cellPhone (string)
. corporateName (string)
. tradeName (string)
. stateRegistration (string)
. isFreeStateRegistration (boolean)
. priceTables (string)
. restrictions (object)
} (object) required
masterdata_api_v10_2/patch_api_dataentities_cl_documents_by_idPartially updates a customer profile. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -----id (string)
_schema (string)
Content-Type (string) required
Accept (string) required
data: {
. email (string)
. firstName (string)
. lastName (string)
. phone (string)
. documentType (string)
. document (string)
. isCorporate (boolean)
. isNewsletterOptIn (boolean)
. localeDefault (string)
. corporateDocument (string)
. homePhone (string)
. cellPhone (string)
. corporateName (string)
. tradeName (string)
. stateRegistration (string)
. isFreeStateRegistration (boolean)
. priceTables (string)
. restrictions (object)
} (object) required
masterdata_api_v10_2/delete_api_dataentities_cl_documents_by_idDeletes a customer profile. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --------------id (string)
Content-Type (string) required
Accept (string) required
masterdata_api_v10_2/post_api_dataentities_ad_documentsCreates new customer address. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | ------------Content-Type (string) required
Accept (string) required
_schema (string)
data: {
. addressName (string)
. addressLabel (string)
. addressType (string)
. receiverName (string)
. city (string)
. state (string)
. country (string)
. postalCode (string)
. street (string)
. number (string)
. neighborhood (string)
. complement (string)
. reference (string)
. geoCoordinate (string)
. userId (string)
} (object) required
masterdata_api_v10_2/get_api_dataentities_ad_documents_by_address_idThis endpoint retrieves information of a specific address by its unique identifier. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:addressId (string)
Content-Type (string) required
Accept (string) required
_fields (string) required
masterdata_api_v10_2/patch_api_dataentities_ad_documents_by_address_idThis endpoint allows you to update an existing address document in the AD data entity. Partially updates a customer address. ⚠️ When updating addresses you must send each field according to the specifications provided. Otherwise, the Checkout module will not be able to autofill data during the shopping flow, which can block the purchase. Learn more about SmartCheckout - Customer information automatic fill-inhttps://help.vtex.com/en/tutorial/smartcheckout-preenchimento-automatico-de-dados-do-claddressId (string)
_schema (string)
Content-Type (string) required
Accept (string) required
data: {
. addressName (string)
. addressLabel (string)
. addressType (string)
. receiverName (string)
. city (string)
. state (string)
. country (string)
. postalCode (string)
. street (string)
. number (string)
. neighborhood (string)
. complement (string)
. reference (string)
. geoCoordinate (string)
. userId (string)
} (object) required
masterdata_api_v10_2/delete_api_dataentities_ad_documents_by_address_idThis endpoint allows you to delete a specific address document from the AD data entity. Deletes a customer address. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicaaddressId (string)
Content-Type (string) required
Accept (string) required
masterdata_api_v10_2/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
message_center/post_api_mail_service_pvt_providers_by_email_provider_dkimCreate DKIM keyshttps://developers.vtex.com/docs/guides/setting-up-dkim-for-transactional-emails for a sender that was set uphttps://help.vtex.com/en/tracks/transactional-emails--6IkJwttMw5T84mlY9RifRP/42LVaxtFb2VHX9xTZU58qC in VTEX mail servers. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YyEmailProvider (string)
message_center/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
operational_capacity/get_api_fulfillment_locations_capacity_by_parent_account_nameRetrieves the current capacities of all locations associated with a parent account. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:Accept (string) required
Content-Type (string) required
operational_capacity/put_api_fulfillment_locations_location_by_location_id_capacities_by_codeUpdates the capacity settings of a specific location for a given task type code. The API allows configuration of capacity parameters such as capacity type, unit, and actions that control the operational capacity of the location. If a field is omitted, the current values will be preserved. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutolocationId (string)
code (string)
Accept (string) required
Content-Type (string) required
data: {
. capacityType (string)
. capacityUnit (string)
. fullCapacityAction (string)
. maxIncreasePromise (object)
. dayCapacity (object)
} (object) required
operational_capacity/get_api_fulfillment_locations_locations_by_location_id_capacitiesLists the capacity details for the next daysRequested days for the specified location. If daysRequested is not provided, it defaults to 3 days. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403locationId (string)
Accept (string) required
Content-Type (string) required
daysRequested (integer)
operational_capacity/get_api_fulfillment_locations_locationRetrieves a paginated list of fulfillment locations that match the given search criteria and status filter. Pagination is controlled via page and pageSize parameters. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will recAccept (string) required
Content-Type (string) required
page (integer)
pageSize (integer)
status (string)
search (string)
operational_capacity/put_api_fulfillment_locations_locations_by_location_id_statusUpdates the status of a specific location identified by locationId to either ACTIVE or MANUALLY_PAUSED. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resourcelocationId (string)
Accept (string) required
Content-Type (string) required
data: {
. status (string)
} (object) required
operational_capacity/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
orders_api_pii_version/get_api_orders_pvt_document_by_order_idRetrieves order details by searching by order ID. If you wish to retrieve unmasked data, use the reason query parameter. ⚠️ Throttling: Each VTEX account can make up to 6000 requests per minute. You can only access information from orders created in the last two years, and that same period is valid for customers through My Accounthttps://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh. Check the Orders onboarding guidehttps://developers.vtex.com/vtex-rest-apiorderId (string)
Content-Type (string) required
Accept (string) required
reason (string)
orders_api_pii_version/post_api_orders_extendsearch_ordersRetrieves a list of orders according to the query parameters used. The response returns masked order data. ⚠️ Throttling: Each account can make up to 6000 requests per minute. Endpoint not meant for integrations This request only retrieves orders that have been indexed, which takes aproximately four minutes. The information returned also may present inconsistencies or become unavailable in periods of peak order volume. Therefore, you must not use the List orders endpoint for integraContent-Type (string) required
Accept (string) required
data: {
. f_status (string)
. f_creationDate (string)
. incompleteOrders (boolean)
. filterError (string)
. per_page (integer)
. page (integer)
. orderBy (string)
. q (string)
. sku_Ids (string)
. listId (string)
. f_authorizedDate (string)
. f_paymentNames (string)
. paymentId (string)
. pci_tid (string)
. nsu (string)
. f_hasInputInvoice (boolean)
. f_hasOutputInvoice (boolean)
. f_invoicedDate (string)
. f_shippingEstimate (string)
. f_sellerNames (string)
. f_affiliateId (string)
. f_callCenterOperatorName (string)
. f_isInstore (boolean)
. f_RnB (string)
. salesChannelId (string)
. f_salesChannel (string)
} (object) required
orders_api_pii_version/post_api_orders_pvt_document_by_order_id_actions_start_handlingChanges the order statushttps://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196 in the workflow to the handling status. ℹ️ Successful requests receive a 204 status code with no content. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully runorderId (string)
Content-Type (string) required
Accept (string) required
orders_api_pii_version/post_api_orders_pvt_document_by_order_id_cancelRequests order cancelation by searching by order ID. It is possible for the seller to decline an order cancelation requesthttps://help.vtex.com/en/tutorial/declining-order-cancelation--F2n0h1TeQ5td540Gjyff4, know more in Order canceling improvementshttps://developers.vtex.com/docs/guides/order-canceling-improvements. ⚠️ You can only cancel an order in the invoiced statushttps://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196 if you send a return invoice first, using the OrdeorderId (string)
Content-Type (string) required
Accept (string) required
data: {
. reason (string)
} (object) required
orders_api_pii_version/post_api_orders_pvt_document_by_order_id_invoicesEndpoint used by the seller after order invoicing to send the invoice information to the marketplace. Once the seller has the order tracking information, it is also possible to use this endpoint to send order tracking information to the marketplace. ⚠️ To avoid price rounding errors, we strongly recommend sending the object with the invoiced items in the request body. ❗ It is not allowed to use the same invoiceNumber in more than one request. Permissions Any user or API keyhttorderId (string)
Content-Type (string) required
Accept (string) required
data: {
. type (string)
. issuedDate (string)
. invoiceNumber (string)
. invoiceValue (integer)
. extraValue (integer)
. invoiceKey (string)
. invoiceUrl (string)
. courier (string)
. trackingNumber (string)
. trackingUrl (string)
. items (array)
. cfop (string)
. volumes (integer)
} (object) required
orders_api_pii_version/post_api_orders_pvt_document_by_order_id_payment_by_payment_id_notify_paymentSends the payment notification of an order by searching by order ID and payment ID. For more information about transaction details, check the article Viewing the order's details in Ordershttps://help.vtex.com/en/tutorial/viewing-the-orders-details-in-orders--tutorials_452. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/licenseorderId (string)
paymentId (string)
Content-Type (string) required
Accept (string) required
orders_api_pii_version/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
orders/get_api_oms_pvt_orders_by_order_idRetrieves order details by searching by order ID or sequence number. ⚠️ Throttling: Each VTEX account can make up to 6000 requests per minute. You can only access information from orders created in the last two years, and that same period is valid for customers through My Accounthttps://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh. Check the Orders onboarding guidehttps://developers.vtex.com/vtex-rest-api/docs/orders-overview. We created this guide to improveorderId (string)
orders/get_api_oms_pvt_orders_order_group_by_order_groupRetrieves details about all orders related to the same purchase by searching by order group ID. ⚠️ Throttling: Each VTEX account can make up to 6000 requests per minute. You can only access information from orders created in the last two years, and that same period is valid for customers through My Accounthttps://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-aorderGroup (string)
orders/get_api_oms_pvt_ordersRetrieves a list of orders according to the filters described below. ⚠️ B2B Buyer Portal When filtering by contact information fieldshttps://developers.vtex.com/docs/api-reference/b2b-contact-information-api post-/api/dataentities/contact_information/documents, you must use the exact value of the field in the contact information. Partial matches are not supported. The limit of information retrieval is 30 pages, the default number of orders per page is 15 and it is possible to configorderBy (string)
page (integer)
per_page (integer)
f_hasInputInvoice (boolean)
q (string)
f_shippingEstimate (string)
f_invoicedDate (string)
f_creationDate (string)
f_authorizedDate (string)
f_UtmSource (string)
f_sellerNames (string)
f_callCenterOperatorName (string)
f_salesChannel (string)
salesChannelId (string)
f_affiliateId (string)
f_status (string)
incompleteOrders (boolean)
f_paymentNames (string)
f_RnB (string)
searchField (string)
f_isInstore (boolean)
orders/post_api_oms_pvt_orders_by_order_id_start_handlingChanges the status of an order to indicate that it is in handling. Expect a status 204 response with no content in case of a successful request. The store must validate this response to retry the call if the response differs from the 204 code, making this flow the store's responsibility. This endpoint can also respond with status 500. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriateorderId (string)
orders/post_api_oms_pvt_orders_by_order_id_cancelCancels an order using its identification code orderId. A common scenario is when the seller has a problem fulfilling the order and requests the marketplace to cancel it. Orders that cannot be canceled The following situations do not allow order cancellation: - Partial invoices: Partially invoicedhttps://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe orders cannot be canceled. However, the customer can change the orderhttps://developers.vtex.com/docs/orderId (string)
data: {
. reason (string)
} (object) required
orders/post_api_oms_pvt_orders_by_order_id_changesThis request allows modifying an orderhttps://help.vtex.com/en/tutorial/changing-items-from-a-completed-order--tutorials_190 by: - Adding items to an order. - Removing items from an order. - Applying discounts to the total value of the order. - Incrementing the total value of the order. ❗ This endpoint is being deprecated in March 1st, 2026. We stopped providing support for this API since December 31st, 2025. If you wish to modify an order, you can use the Create order modificatiorderId (string)
data: {
. requestId (string)
. reason (string)
. discountValue (integer)
. incrementValue (integer)
. itemsRemoved (array)
. itemsAdded (array)
} (object) required
orders/post_api_oms_pvt_orders_by_order_id_interactionsAdd a Log in Interactions Order Array. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | ---orderId (string)
data: {
. source (string)
. message (string)
} (object) required
orders/post_api_oms_pvt_orders_by_order_id_invoiceThis request is used for invoicing an orderhttps://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/2WgQrlHTyVo4hLjhUs1LMT. Entering the order's invoice means it was successfully completed, and the order status can be changed to invoiced in the order flowhttps://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196. Once an order is invoiced, its status cannot be changed. After the insertion of the invoice, the order's total value will be updated, even in partial invoicehttps:orderId (string)
data: {
. type (string)
. issuanceDate (string)
. invoiceNumber (string)
. invoiceValue (string)
. invoiceKey (string)
. invoiceUrl (string)
. embeddedInvoice (string)
. courier (string)
. trackingNumber (string)
. trackingUrl (string)
. dispatchedDate (string)
. items (array)
} (object) required
orders/patch_api_oms_pvt_orders_by_order_id_invoice_by_invoice_numberUpdate a given order, adding its tracking number to its Partial invoicehttps://help.vtex.com/en/tracks/pedidos--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe. After using this call to add a tracking number to an order, you can use the Update order tracking statushttps://developers.vtex.com/docs/api-reference/orders-api put-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-/tracking API request to add tracking events. Permissions Any user or API keyhttps://developers.vtex.com/docsorderId (string)
invoiceNumber (string)
data: {
. trackingNumber (string)
. trackingUrl (string)
. dispatchedDate (string)
. courier (string)
} (object) required
orders/put_api_oms_pvt_orders_by_order_id_invoice_by_invoice_number_trackingThis endpoint sends a tracking event to an order that already has a tracking number registered to its invoice. This request is not meant to send a tracking number and URL to the invoice. If you wish to send a tracking number and URL to an order, use the Update order's partial invoicehttps://developers.vtex.com/docs/api-reference/orders-api patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber- endpoint. For more information, see Partial invoicehttps://help.vtex.com/en/tracks/partial-invoorderId (string)
invoiceNumber (string)
data: {
. isDelivered (boolean)
. deliveredDate (string)
. events (array)
} (object) required
orders/get_api_oms_pvt_orders_by_order_id_conversation_messageList all order conversations of an order by its order ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategoryorderId (string)
orders/get_api_oms_pvt_orders_by_order_id_payment_transactionRetrieves transaction details by order ID. All events in the transaction will be registered in this call's response body. In scenarios of order changeshttps://developers.vtex.com/vtex-rest-api/reference/registerchange, it is possible to insert a Partial invoicehttps://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe. The total value of the order will be updated after the insertion of the invoice, even when there is a Partial invoicehttps://help.vtex.com/en/tracks/ororderId (string)
orders/post_api_oms_pvt_orders_by_order_id_payments_by_payment_id_payment_notificationSend a payment notification of a given order, by order ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategoryorderId (string)
paymentId (string)
orders/get_api_oms_pvt_feed_orders_statusGet feed order status deprecatedmaxLot (string) required
orders/get_api_orders_feed_configThe Orders Feed v3 is the best way to create order integrations. Below you can find details on the configuration API specification, and to know more see our Feed v3 guidehttps://developers.vtex.com/vtex-rest-api/docs/orders-feed and our order integration guidehttps://developers.vtex.com/vtex-rest-api/docs/erp-integration-set-up-order-integration. 📘 Onboarding guide Check the new Orders onboarding guidehttps://developers.vtex.com/vtex-rest-api/docs/orders-overview. We created this guideNo parameters
orders/post_api_orders_feed_configThe Orders Feed v3 is the best way to create order integrations. Below you can find details on the configuration API specification, and to know more see our Feed v3 guidehttps://developers.vtex.com/vtex-rest-api/docs/orders-feed and our order integration guidehttps://developers.vtex.com/vtex-rest-api/docs/erp-integration-set-up-order-integration There are two types of filtering that can be used. The FromWorkflow type filters orders by status, whereas the FromOrders type uses JSONata expressiodata: {
. filter (object)
. queue (object)
} (object) required
orders/delete_api_orders_feed_configDeletes the configuration set up in Feed v3https://developers.vtex.com/docs/guides/orders-feed. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for tNo parameters
orders/get_api_orders_feedRetrieve items from feedhttps://developers.vtex.com/docs/guides/orders-feed queue. The event will be removed if the message send retry is equal to, or greater than the maximum retention period. This API will return 404 Not Found if there is no Feed Configurationhttps://developers.vtex.com/docs/guides/orders-feed available for the given X-VTEX-API-AppKey.maxlot (string) required
orders/post_api_orders_feedCommit items in the feedhttps://developers.vtex.com/docs/guides/orders-feed queue.data: {
. handles (array)
} (object) required
orders/get_api_orders_hook_configRetrieves a given hook's configuration details. Learn more with the orders hook guidehttps://developers.vtex.com/vtex-rest-api/docs/orders-feed hook. 📘 Onboarding guide Check the new Orders onboarding guidehttps://developers.vtex.com/vtex-rest-api/docs/orders-overview. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Orders and is organized by focusing on the developer's journey. PermiclientEmail (string)
page (string)
per_page (string)
orders/post_api_orders_hook_configConfigures filtering rules applied to orders hook. Learn more with the orders hook guidehttps://developers.vtex.com/vtex-rest-api/docs/orders-feed hook. There are two types of filtering that can be used: - FromWorkflow: filters orders by status. - FromOrders: uses JSONata expressions to filter orders according to any property in the orders JSON document. This enables stores to filter delivered orders and orders in which products have been added or removed, for example. To leardata: {
. filter
. hook
} (object) required
orders/delete_api_orders_hook_configDeletes a given hook configuration. Learn more with the orders hook guidehttps://developers.vtex.com/vtex-rest-api/docs/orders-feed hook.No parameters
orders/get_api_orders_pvt_document_by_order_id_change_summaryThis endpoint retrieves a summary of modifications of every successful Create order modifications requesthttps://developers.vtex.com/docs/api-reference/orders-api patch-/api/order-system/orders/-changeOrderId-/changes made to an order and provides an overview of each request. ⚠️ If you want information about all the modifications made to an order, use the Get order modifications history endpointhttps://developers.vtex.com/docs/api-reference/orders-api get-/api/order-system/orders/-changeOrderorderId (string)
orders/get_api_oms_user_ordersLists all orders. You can only access information from orders created in the last two years, and that same period is valid for customers through My Accounthttps://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh. B2C orders You can use this endpoint to list all orders from a given customer, filtering by their email. B2B Buyer Portal orders You can use this endpoint to list orders by filtering with the following fields: - Text: texts iclientEmail (string)
page (string)
per_page (string)
text (string)
status (string)
creation_date (string)
purchase_agent_id (string)
my_pending_approvals (boolean)
orders/get_api_oms_user_orders_by_order_idLists all details from an order, through the perspective of the customer who placed the order. You can only access information from orders created in the last two years, and that same period is valid for customers through My Accounthttps://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh. B2B Buyer Portal orders You can use this endpoint to list orders by filtering with the following fields: - Text: texts in existing order fields, custom fieldshttpsorderId (string)
clientEmail (string)
text (string)
status (string)
creation_date (string)
purchase_agent_id (string)
my_pending_approvals (boolean)
orders/post_api_orders_expressions_jsonataThis endpoint allows you to test a JSON document with a JSONata expression, returning true if the document meets the criteria posed in the expression, or false if it does not. Since JSONata expressions can be used to filter order updates in the Orders API feed and hookhttps://developers.vtex.com/docs/guides/orders-feed, this endpoint can be used to test an expression's results before configuring the feed or hookhttps://developers.vtex.com/docs/guides/orders-feed. Learn more about how to usdata: {
. Expression (string)
. Document (string)
} (object) required
orders/get_api_checkout_pvt_configuration_window_to_change_sellerRetrieves a marketplace's window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it. The default period for this window is of 2 days, but it can be configured by the request Update window to change seller.No parameters
orders/post_api_checkout_pvt_configuration_window_to_change_sellerUpdates a marketplace's window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it. It is possible to check the current window using the request Get window to change seller.data: {
. waitingTime (integer)
} (object) required
orders/patch_api_order_system_orders_by_change_order_id_changesOrder modificationshttps://help.vtex.com/docs/tutorials/how-order-modification-works feature allows you to modify an order, whether the modification is motivated by customer mistakes, product unavailability, or others. Both sellers and marketplaces can use this endpoint and modify orders in multiple scenarios, and it is possible to make a single modification or combine multiple ones in the same request. The possible order modifications operations you can perform are the following: - Add: AddichangeOrderId (string)
accountName (string) required
data: {
. reason (string)
. replace (array)
} (object) required
orders/get_api_order_system_orders_by_change_order_id_changesThis endpoint retrieves a history of every successful Create order modifications requesthttps://developers.vtex.com/docs/api-reference/orders-api patch-/api/order-system/orders/-changeOrderId-/changes made to an order and provides detailed information about each request. You can access an order's history using the changeOrderId, which corresponds to its orderId. If you want detailed information about a single modification request, you can use the endpoint Get order modifications detailshtchangeOrderId (string)
an (string) required
orders/get_api_order_system_orders_by_change_order_id_changes_by_change_request_idThis endpoint retrieves detailed information about a specific order modification. So after creating multiple modifications, you can get information on each one of them by its changeRequestId, the unique identification code generated by the Create order modificationshttps://developers.vtex.com/docs/api-reference/orders-api patch-/api/order-system/orders/-changeOrderId-/changes endpoint. The successful status code is 200 OK, and its response body schema is very similar to the Create order modifchangeOrderId (string)
changeRequestId (string)
an (string) required
orders/post_api_order_system_orders_by_change_order_id_changes_previewThis endpoint allows you to simulate an order modification and preview what the real modification will look like if you use the Create order modificationshttps://developers.vtex.com/docs/api-reference/orders-api patch-/api/order-system/orders/-changeOrderId-/changes endpoint. A preview is especially useful for more complex scenarios, such as orders with multiple items and combinations of change operations — add, remove, and replace. Ensuring you get the desired results before making the actual mchangeOrderId (string)
an (string) required
data: {
. reason (string)
. replace (array)
} (object) required
orders/post_api_order_system_orders_by_change_order_id_changes_by_change_request_id_retryThis endpoint makes a new attempt to perform an order modification previously made using the Create order modificationshttps://developers.vtex.com/docs/api-reference/orders-api patch-/api/order-system/orders/-changeOrderId-/changes endpoint that, for some reason, was not completely processed. To make this request, you need the changeRequestId, a unique change identification code that you get when you make a Create order modificationshttps://developers.vtex.com/docs/api-reference/orders-api pachangeOrderId (string)
changeRequestId (string)
an (string) required
data: {
. reason (string)
. replace (array)
} (object) required
orders/post_api_order_system_orders_by_change_order_id_changes_by_change_request_id_cancelThis endpoint cancels an order modificationhttps://developers.vtex.com/docs/api-reference/orders-api patch-/api/order-system/orders/-changeOrderId-/changes. It is meant for when, due to an error, a modification was not completely processed, and you do not wish to retryhttps://developers.vtex.com/docs/api-reference/orders-api post-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-/retry it. For this request, you need the order's changeRequestId, the unique identification code genechangeOrderId (string)
changeRequestId (string)
an (string) required
data: {
. reason (string)
} (object) required
orders/put_api_order_system_orders_changes_settingsUpdates the Order modificationshttps://developers.vtex.com/docs/api-reference/orders-api patch-/api/order-system/orders/-changeOrderId-/changes settings from a store. ℹ️ To know more about Order modifications, see How Order modifications workshttps://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manaan (string) required
data: {
. paymentConfiguration (object)
. rolloutConfiguration (object)
. pipelineConfiguration (object)
} (object) required
orders/get_api_order_system_orders_changes_settingsRetrieves the Order modifications settingshttps://developers.vtex.com/docs/api-reference/orders-api put-/api/order-system/orders/changes/settings from a store. ℹ️ To know more about Order modifications, see How Order modifications workshttps://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager rean (string) required
orders/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
organization_units/get_api_organization_units_v1_users_by_user_id_scopesRetrieves all scopes associated with a user's organization unit. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise,userId (string)
Content-Type (string) required
Accept (string) required
organization_units/get_api_organization_units_v1_by_user_id_unitRetrieves the organization unit associated with a specific user. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise,userId (string)
Content-Type (string) required
Accept (string) required
organization_units/post_api_organization_units_v1Creates a new organization unit at the root level of the organizational hierarchy. After creation, you can move the organization unit to a desired parent using the PUT Move organization unithttps://developers.vtex.com/docs/api-reference/organization-units-api put-/api/organization-units/v1/-organizationUnitId-/path endpoint. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developersContent-Type (string) required
Accept (string) required
data: {
. name (string)
} (object) required
organization_units/get_api_organization_units_v1Searches for organization units based on query parameters, with pagination support. If no name filter is provided, returns all organization units for the account. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-name (string)
page (integer)
pageSize (integer)
Content-Type (string) required
Accept (string) required
organization_units/get_api_organization_units_v1_by_organization_unit_idRetrieves details of a specific organization unit by its unique identifier. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request.organizationUnitId (string)
Content-Type (string) required
Accept (string) required
organization_units/delete_api_organization_units_v1_by_organization_unit_idDeletes an organization unit. If the unit has children and the cascade parameter is true, all children will also be deleted. If cascade is false and the unit has children, the request will fail. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://heorganizationUnitId (string)
cascade (boolean)
Content-Type (string) required
Accept (string) required
organization_units/patch_api_organization_units_v1_by_organization_unit_idUpdates the name of an existing organization unit. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, they will receorganizationUnitId (string)
data: {
. name (string)
} (object) required
organization_units/get_api_organization_units_v1_by_organization_unit_id_childrenLists all children of a specific organization unit. The shallowSearch parameter controls whether to retrieve only direct children or all descendants. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resouorganizationUnitId (string)
shallowSearch (boolean)
Content-Type (string) required
Accept (string) required
organization_units/get_api_organization_units_v1_rootsRetrieves all root-level organization units for the account. Root units are top-level units with no parent. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able toContent-Type (string) required
Accept (string) required
organization_units/put_api_organization_units_v1_by_organization_unit_id_pathMoves an organization unit to a different parent in the hierarchy. If no parentId is provided in the request body, the organization unit becomes a root organization unit. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/organizationUnitId (string)
Content-Type (string) required
Accept (string) required
data: {
. parentId (string)
} (object) required
organization_units/post_api_vtexid_organization_units_by_organization_unit_id_usersAdds a user to a specific organization unit. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, they will receive aorganizationUnitId (string)
force (boolean) required
data: {
. userIds (array)
} (object) required
organization_units/delete_api_vtexid_organization_units_by_organization_unit_id_usersRemoves one or more users from a specific organization unit. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, theyorganizationUnitId (string)
Content-Type (string) required
Accept (string) required
data: {
. userIds (array)
} (object) required
organization_units/get_api_vtexid_organization_units_by_organization_unit_id_usersRetrieves all users associated with a specific organization unit. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise,organizationUnitId (string)
Content-Type (string) required
Accept (string) required
organization_units/get_api_organization_units_v1_by_organization_unit_id_scopesRetrieves all scopes defined for a specific organization unit. Scopes represent domain-specific attributes such as contract IDs, collection IDs, or addresses. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manaorganizationUnitId (string)
Content-Type (string) required
Accept (string) required
organization_units/delete_api_organization_units_v1_by_organization_unit_id_scopesDeletes all scopes from an organization unit. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, they will receive aorganizationUnitId (string)
Content-Type (string) required
Accept (string) required
organization_units/post_api_organization_units_v1_by_organization_unit_id_scopes_by_scopeCreates a new scope with specified values for an organization unit. If the scope already exists, this operation will fail. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6eukorganizationUnitId (string)
scope (string)
Content-Type (string) required
Accept (string) required
data: {
. ids (array)
} (object) required
organization_units/put_api_organization_units_v1_by_organization_unit_id_scopes_by_scopeUpdates an existing scope by replacing all its values with the provided set. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request.organizationUnitId (string)
scope (string)
Content-Type (string) required
Accept (string) required
data: {
. ids (array)
} (object) required
organization_units/delete_api_organization_units_v1_by_organization_unit_id_scopes_by_scopeDeletes a specific scope from an organization unit, removing all associated values. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this rorganizationUnitId (string)
scope (string)
organization_units/delete_api_organization_units_v1_by_organization_unit_id_scopes_by_scope_removeRemoves specific values from an organization unit scope without deleting the entire scope. If all values are removed, the scope remains but with an empty set of values. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/liorganizationUnitId (string)
scope (string)
Content-Type (string) required
Accept (string) required
data: {
. ids (array)
} (object) required
organization_units/get_api_organization_units_v1_scope_by_scope_value_by_scope_valueRetrieves all organization units that have a specific scope value. This is useful for reverse lookups, such as finding which organization units are associated with a particular contract ID. ⚠️ This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtscope (string)
scopeValue (string)
Content-Type (string) required
Accept (string) required
organization_units/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
payment_provider_protocol/get_manifestExposes the provider manifest, including metadata settings such as payment methods, split configuration, and custom fields. ℹ️ This request is made from VTEX to the payment provider. Available payment methods | Payment Method | Type | Country | |---|---|---| | Visa | Credit Card | Global | | Mastercard | Credit Card | Global | | American Express | Credit Card | Global | | Discover | Credit Card | Global | | JCB | Credit Card | Global | | Diners | Credit Card | Global | | EloContent-Type (string) required
Accept (string) required
payment_provider_protocol/post_paymentsCreates a new payment and initiates the payment flow. ℹ️ This request is made from VTEX to the payment provider. Payment providers must: - Execute authorization on payments made through credit/debit card or any synchronized payments; - Return the required information to the customer on payments made through bank-issued invoice, redirect, or any async payments. ℹ️ This endpoint has to meet the principle of idempotencehttps://en.wikipedia.org/wiki/Idempotence. When calling this enX-PROVIDER-API-AppKey (string) required
X-PROVIDER-API-AppToken (string) required
Content-Type (string) required
Accept (string) required
data: {
. reference (string)
. orderId (string)
. shopperInteraction (string)
. verificationOnly (boolean)
. transactionId (string)
. paymentId (string)
. paymentMethod (string)
. paymentMethodCustomCode (string)
. merchantName (string)
. value (number)
. referenceValue (number)
. currency (string)
. installments (number)
. installmentsInterestRate (number)
. installmentsValue (number)
. deviceFingerprint (string)
. ipAddress (string)
. card (object)
. miniCart (object)
. recipients (array)
. merchantSettings (array)
. url (string)
. inboundRequestUrl (string)
. secureProxyUrl (string)
. sandBoxMode (boolean)
. totalCartValue (number)
. callbackUrl (string)
. returnUrl (string)
. connectorMetadata (array)
} (object) required
payment_provider_protocol/post_payments_by_payment_id_cancellationsCancels a payment that was not yet approved or settled. ℹ️ This request is made from VTEX to the payment provider. Permissions Check with your service provider to know what permissions are needed.paymentId (string)
X-PROVIDER-API-AppKey (string) required
X-PROVIDER-API-AppToken (string) required
Content-Type (string) required
Accept (string) required
data: {
. paymentId (string)
. requestId (string)
. authorizationId (string)
. tid (string)
. transactionId (string)
. value (number)
. nsu (string)
. sandboxMode (boolean)
. merchantSettings (array)
. connectorMetadata (array)
} (object) required
payment_provider_protocol/post_payments_by_payment_id_settlementsSettles a payment that was previously approved. ℹ️ This request is made from VTEX to the payment provider. Permissions Check with your service provider to know what permissions are needed.paymentId (string)
X-PROVIDER-API-AppKey (string) required
X-PROVIDER-API-AppToken (string) required
Content-Type (string) required
Accept (string) required
data: {
. transactionId (string)
. requestId (string)
. paymentId (string)
. value (number)
. authorizationId (string)
. tid (string)
. nsu (string)
. recipients (array)
. sandboxMode (boolean)
. merchantSettings (array)
. connectorMetadata (array)
} (object) required
payment_provider_protocol/post_payments_by_payment_id_refundsRefunds a payment in full or in part that was previously settled. ℹ️ This request is made from VTEX to the payment provider. ⚠️ The request should return a success response 200 only after the settlement has been fully completed. If there is any delay or the settlement has not yet been finalized, the response must indicate an error message 500. This allows VTEX payment module to continue retrying the request for up to 24 hours, until the settlement is definitively confirmed. A 200 status cpaymentId (string)
X-PROVIDER-API-AppKey (string) required
X-PROVIDER-API-AppToken (string) required
Content-Type (string) required
Accept (string) required
data: {
. requestId (string)
. settleId (string)
. paymentId (string)
. tid (string)
. value (number)
. transactionId (string)
. authorizationId (string)
. nsu (string)
. recipients (array)
. sandboxMode (boolean)
. merchantSettings (array)
. connectorMetadata (array)
} (object) required
payment_provider_protocol/post_payments_by_payment_id_inbound_by_actionThe Inbound request BETA implements an URL that facilitates a direct connection between VTEX Gateway service and the Payment Provider. This functionality allows the payment provider to create other types of specific routes, in addition to those described in the other PPP endpoints, according to their type of operation e.g. hook or enrollment routes, among others. This endpoint forwards a request back to your endpoint using the inboundRequestsUrl provided in the Create Paymenthttps://developepaymentId (string)
action (string)
X-PROVIDER-API-AppKey (string) required
X-PROVIDER-API-AppToken (string) required
Content-Type (string) required
Accept (string) required
data: {
. requestId (string)
. transactionId (string)
. paymentId (string)
. authorizationId (string)
. nsu (string)
. tid (string)
. requestData
. merchantSettings (array)
. connectorMetadata (array)
} (object) required
payment_provider_protocol/post_authorization_tokenCreates the authorization token that will be used for VTEX to redirect the merchant to the provider's authentication application. For more information about the Payment Provider Protocol PPP merchant authentication procedure, visit Configuration Flowhttps://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider configuration-flow. ℹ️ This request is made from VTEX to the payment provider. Permissions Check with your service provider to know what permissX-PROVIDER-API-AppKey (string) required
X-PROVIDER-API-AppToken (string) required
Content-Type (string) required
Accept (string) required
data: {
. applicationId (string)
. returnUrl (string)
} (object) required
payment_provider_protocol/get_authorization_redirectUse the application of provider for merchant's authentication. VTEX will redirect the merchant to your application using the token we retrieved earlier. You're expected to have a signup/signin process on your side in order to authenticate the merchant, either as a new or as an existent user. At this point, you can present your terms an conditions, a contract, and ask for merchant's final agreement to use your services. Finally, you need to generate an authorizationCode that you mustX-PROVIDER-API-AppKey (string) required
X-PROVIDER-API-AppToken (string) required
Content-Type (string) required
Accept (string) required
applicationId (string) required
token (string) required
payment_provider_protocol/get_authorization_credentialsRetrieves the merchant credentials applicationId, appKey and appToken registered with the payment provider. These credentials will be saved in the VTEX system and activated when the retailer decides to enable the connector. For more information about the Payment Provider Protocol PPP merchant authentication procedure, visit Configuration Flowhttps://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider configuration-flow. ℹ️ This request is made from VTEX tX-PROVIDER-API-AppKey (string) required
X-PROVIDER-API-AppToken (string) required
Content-Type (string) required
Accept (string) required
applicationId (string) required
authorizationCode (string) required
payment_provider_protocol/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
payments_gateway/servers_api_pvt_installmentsNo description availableNo parameters
payments_gateway/get_api_pvt_installmentsReturns the best installment options according to the parameters informed in the request. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endrequest.value (integer) required
request.salesChannel (integer)
request.paymentDetails0.id (integer)
request.paymentDetails0.value (integer)
request.paymentDetails0.bin (integer)
Content-Type (string) required
Accept (string) required
payments_gateway/servers_api_pvt_affiliationsNo description availableNo parameters
payments_gateway/get_api_pvt_affiliationsReturns all affiliations payment and anti-fraud providers that are already configured in your store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources fContent-Type (string) required
Accept (string) required
payments_gateway/post_api_pvt_affiliationsRegisters a new affiliation payment or anti-fraud provider in your store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | ProdContent-Type (string) required
Accept (string) required
data: {
. implementation (string)
. name (string)
. configuration (array)
. isdelivered (boolean)
. isConfigured (boolean)
} (object) required
payments_gateway/servers_api_pvt_affiliations_by_affiliation_idNo description availableaffiliationId (string)
payments_gateway/put_api_pvt_affiliations_by_affiliation_idUpdates information about an affiliation payment or anti-fraud provider configured in your store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources foraffiliationId (string)
Content-Type (string) required
Accept (string) required
data: {
. id (string)
. implementation (string)
. name (string)
. configuration (array)
. isdelivered (boolean)
. isConfigured (boolean)
} (object) required
payments_gateway/get_api_pvt_affiliations_by_affiliation_idReturns data for a specific affiliation payment or anti-fraud provider. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | ProducaffiliationId (string)
Content-Type (string) required
Accept (string) required
payments_gateway/servers_api_pvt_rulesNo description availableNo parameters
payments_gateway/get_api_pvt_rulesReturns all payment rules applied to the payment providers configured in your store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpointContent-Type (string) required
Accept (string) required
payments_gateway/post_api_pvt_rulesCreates a new payment rule to be applied to the payment providers configured in your store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this eContent-Type (string) required
Accept (string) required
data: {
. name (string)
. salesChannels
. paymentSystem
. connector
. issuer
. antifraud
. installmentOptions (object)
. isSelfAuthorized (boolean)
. requiresAuthentication (boolean)
. enabled (boolean)
. installmentsService (boolean)
. isDefault (boolean)
. beginDate (string)
. endDate (string)
. condition (object)
. multiMerchantList (array)
. country (object)
. dateIntervals (array)
. externalInterest (boolean)
. minimumValue (number)
. deadlines (array)
. cobrand (object)
. cardLevel (object)
. excludedBinsRanges (number)
} (object) required
payments_gateway/servers_api_pvt_rules_by_rule_idNo description availableruleId (string)
payments_gateway/get_api_pvt_rules_by_rule_idReturns data for a specific payment rule applied to the payment providers configured in your store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources foruleId (string)
Content-Type (string) required
Accept (string) required
payments_gateway/put_api_pvt_rules_by_rule_idUpdates information about a specific payment rule applied to the payment providers configured in your store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resruleId (string)
Content-Type (string) required
Accept (string) required
data: {
. id (string)
. name (string)
. salesChannels
. paymentSystem
. connector
. issuer
. antifraud
. installmentOptions (object)
. isSelfAuthorized (boolean)
. requiresAuthentication (boolean)
. enabled (boolean)
. installmentsService (boolean)
. isDefault (boolean)
. beginDate (string)
. endDate (string)
. condition (object)
. multiMerchantList (array)
. country (object)
. dateIntervals (array)
. externalInterest (boolean)
. minimumValue (number)
. deadlines (array)
. cobrand (object)
. cardLevel (object)
. excludedBinsRanges (number)
} (object) required
payments_gateway/delete_api_pvt_rules_by_rule_idDeletes a specific payment rule applied to the payment providers configured in your store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this enruleId (string)
Content-Type (string) required
Accept (string) required
payments_gateway/servers_api_pvt_merchants_payment_systemsNo description availableNo parameters
payments_gateway/get_api_pvt_merchants_payment_systemsReturns all payment methods such as Visa, Master, among others that can be used in your store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for thisalesChannel (integer)
Content-Type (string) required
Accept (string) required
payments_gateway/servers_api_payments_pvt_account_by_card_idNo description availablecardId (string)
payments_gateway/get_api_payments_pvt_account_by_card_idRetrieves the public data of a specific credit card stored in the store. Before consulting the card details, consider the following information: - Sensitive data such as full card number and CVV are not returned. - The tokens field is optional. It is included in the response only if the card you are retrieving has already been tokenized. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriatecardId (string)
Content-Type (string) required
Accept (string) required
payments_gateway/servers_api_pvt_transactionsNo description availableNo parameters
payments_gateway/post_api_pvt_transactionsThis request is the first step to create a new transaction. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CategoryContent-Type (string) required
Accept (string) required
data: {
. value (number)
. referenceId (string)
. channel (string)
. urn (string)
. salesChannel (string)
} (object) required
payments_gateway/servers_api_payments_transactions_by_transaction_id_paymentsNo description availabletransactionId (string)
payments_gateway/post_api_payments_transactions_by_transaction_id_paymentsThis request is used to send the payment data. Permissions This endpoint does not require authenticationhttps://developers.vtex.com/docs/guides/authentication or permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.transactionId (string)
an (string) required
orderId (string) required
Content-Type (string) required
Accept (string) required
data (array) required
payments_gateway/servers_api_pvt_transactions_by_transaction_id_additional_dataNo description availabletransactionId (string)
payments_gateway/post_api_pvt_transactions_by_transaction_id_additional_dataThis request sends additional data related to the transaction, such as profile information, shopping cart, shipping data, among others. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. TtransactionId (string)
Content-Type (string) required
Accept (string) required
data (array) required
payments_gateway/patch_api_pvt_transactions_by_transaction_id_additional_dataThis request is used to update any information that has previously been sent on endpoint Send additional datahttps://developers.vtex.com/docs/api-reference/payments-gateway-api post-/api/pvt/transactions/-transactionId-/additional-data, if required. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8transactionId (string)
Content-Type (string) required
Accept (string) required
data (array) required
payments_gateway/servers_api_pvt_transactions_by_transaction_id_authorization_requestNo description availabletransactionId (string)
payments_gateway/post_api_pvt_transactions_by_transaction_id_authorization_requestThis request authorizes the creation of a new transaction according to the data previously informed in the last requests. This step is the trigger to process each of payments that were received in step 2. Each payment will be sent to acquirer. If all payments are authorized, the transaction will be authorized. If one of the payments is denied, all payments in transaction will be cancelled. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-ustransactionId (string)
Content-Type (string) required
Accept (string) required
data: {
. transactionId (string)
. softDescriptor (string)
. prepareForRecurrency (boolean)
} (object) required
payments_gateway/servers_api_pvt_transactions_by_transaction_idNo description availabletransactionId (string)
payments_gateway/get_api_pvt_transactions_by_transaction_idReturns data about a specific transaction made in your store. ⚠️ Do not use the interactions.href route which is part of this endpoint's response. This is an internal-only route not meant to be used by external developers. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be abltransactionId (string)
Content-Type (string) required
Accept (string) required
payments_gateway/servers_api_pvt_transactions_by_transaction_id_payments_by_payment_idNo description availabletransactionId (string)
paymentId (string)
payments_gateway/get_api_pvt_transactions_by_transaction_id_payments_by_payment_idReturns data about all payments created for a transaction or a specific payment made in your store. ⚠️ To get information about a specific payment, use the paymentId parameter in the request path. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run thitransactionId (string)
paymentId (string)
Content-Type (string) required
Accept (string) required
payments_gateway/servers_api_pvt_transactions_by_transaction_id_settlementsNo description availabletransactionId (string)
payments_gateway/get_api_pvt_transactions_by_transaction_id_settlementsReturns settlement data associated with a specific transaction. The response body of this endpoint may return different information depending on the status of the settlement request for the queried transaction: - Transaction settlement not requested or initiated: The response body does not return any data. - Settlement request initiated, but not completed as there are items that have not yet been invoiced in the order: The response body will only display the request array information.transactionId (string)
Content-Type (string) required
Accept (string) required
payments_gateway/servers_api_pvt_transactions_by_transaction_id_settlement_requestNo description availabletransactionId (string)
payments_gateway/post_api_pvt_transactions_by_transaction_id_settlement_requestSettles the transaction amount. A payment settled means that the seller will receive the value of the purchase value after bank conciliation. ℹ️ This call is mandatory to complete a transaction and its payments. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to succestransactionId (string)
Content-Type (string) required
Accept (string) required
data: {
. value (number)
} (object) required
payments_gateway/servers_api_pvt_transactions_by_transaction_id_refunding_requestNo description availabletransactionId (string)
payments_gateway/post_api_pvt_transactions_by_transaction_id_refunding_requestRefunds the amount of the transaction that was previously settled. After a transaction is settled, this request can be used to partially or fully refund the transaction amount. Due to acquirer rules, it is not possible to perform this step online against the acquirer, and, if an error occurrs, we notify the seller company responsible by email to manually check the transaction status against the acquirer. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-autransactionId (string)
Content-Type (string) required
Accept (string) required
data: {
. value (number)
. freight (number)
. tax (number)
. minicart (object)
} (object) required
payments_gateway/servers_api_pvt_transactions_by_transaction_id_cancellation_requestNo description availabletransactionId (string)
payments_gateway/post_api_pvt_transactions_by_transaction_id_cancellation_requestCancels a transaction that was previously approved, but not settled. It is possible to cancel partially or complete value of the transaction. Due to acquirer rules it is not possible to perform this step online against the acquirer. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3transactionId (string)
Content-Type (string) required
Accept (string) required
data: {
. value (number)
} (object) required
payments_gateway/servers_api_payments_pvt_payments_by_payment_id_payment_notificationNo description availablepaymentId (string)
payments_gateway/get_api_payments_pvt_payments_by_payment_id_payment_notificationSends a payment notification for an order based on the payment ID. ℹ If the payment was made on its creation date and for the full amount, use this endpoint. Otherwise, use the alternative endpoint: POST Send payment notification with payment ID, date, and value paidhttps://developers.vtex.com/docs/api-reference/payments-gateway-api post-/api/payments/pvt/payments/-paymentId-/payment-notification. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-ovepaymentId (string)
Content-Type (string) required
Accept (string) required
payments_gateway/post_api_payments_pvt_payments_by_payment_id_payment_notificationSends a payment notification for an order using the payment ID, including the payment date and the value paid. ℹ️ This endpoint should only be used when the payment was not completed on its creation date or was partially completed e.g., $50 out of $100. If the payment was made in full on the creation date, use the GET Send payment notification with payment IDhttps://developers.vtex.com/docs/api-reference/payments-gateway-api get-/api/payments/pvt/payments/-paymentId-/payment-notification endppaymentId (string)
Content-Type (string) required
Accept (string) required
data: {
. paymentDate (string)
. valuePaid (number)
} (object) required
payments_gateway/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
pick_and_pack/post_tokenGenerates a JWT JSON Web Token necessary to access the Pick and Pack API information. To generate the JWT it's necessary to have the API KEY. To obtain this information, access VTEX Admin Shipping Pick and Pack Settings Integration API Key. ℹ️ The authentication token expires after 15 minutes Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vteContent-Type (string) required
Accept (string) required
data: {
. apiKey (string)
} (object) required
pick_and_pack/get_orders_by_order_idRetrieves order details by its ID. ℹ️ The response is cached for 30 seconds based on the orderId parameter. The endpoint supports up to 500 requests per second, with a maximum of 100 concurrent requests. ℹ️ Generate a JWT tokenhttps://developers.vtex.com/docs/api-reference/pick-and-pack-api post-/token to endpoint authentication. JSON Web Token JWT is an open standard RFC 7519 that defines a compact and self-contained way for securely transmitting information as a JSON object between parties.orderId (string)
Content-Type (string) required
Accept (string) required
pick_and_pack/patch_orders_by_order_id_trackingThis endpoint finalizes the Pick and Pack workflow by marking the order as delivered. Additionally, it allows you to update the OMS with shipping details. All fields are optional. For more information, see Update order tracking statushttps://developers.vtex.com/docs/api-reference/orders-api put-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-/tracking endpoint. ℹ️ Generate a JWT tokenhttps://developers.vtex.com/docs/api-reference/pick-and-pack-api post-/token to endpoint authentication. JSorderId (string)
data: {
. deliveredDate (string)
. events (array)
} (object) required
pick_and_pack/get_worksheets_by_worksheet_idRetrieves worksheet details by ID. ℹ️ The response is cached for 30 seconds based on the worksheetId parameter. The endpoint supports up to 500 requests per second, with a maximum of 100 concurrent requests. ℹ️ Generate a JWT tokenhttps://developers.vtex.com/docs/api-reference/pick-and-pack-api post-/token to endpoint authentication. JSON Web Token JWT is an open standard RFC 7519 that defines a compact and self-contained way for securely transmitting information as a JSON object between partiworksheetId (string)
pick_and_pack/get_worksheetsLists all worksheets by order ID. ℹ️ The response is cached for 30 seconds based on the orderId query parameter. The endpoint supports up to 500 requests per second, with a maximum of 100 concurrent requests. ℹ️ Generate a JWT tokenhttps://developers.vtex.com/docs/api-reference/pick-and-pack-api post-/token to endpoint authentication. JSON Web Token JWT is an open standard RFC 7519 that defines a compact and self-contained way for securely transmitting information as a JSON object between partorderId (string) required
pick_and_pack/get_facilities_by_facility_idRetrieves facility details by ID. ℹ️ The response is cached for 30 seconds based on the facilityId parameter. The endpoint supports up to 500 requests per second, with a maximum of 100 concurrent requests. ℹ️ Generate a JWT tokenhttps://developers.vtex.com/docs/api-reference/pick-and-pack-api post-/token to endpoint authentication. JSON Web Token JWT is an open standard RFC 7519 that defines a compact and self-contained way for securely transmitting information as a JSON object between partiesfacilityId (string)
pick_and_pack/get_shipments_by_shipment_idRetrieves detailed information about a shipment using either the internal system ID or the carrier's tracking ID. ℹ️ The response is cached for 30 seconds based on the shipmentId parameter and X-PNP-FilterMethod header. The endpoint supports up to 500 requests per second, with a maximum of 100 concurrent requests. ℹ️ Generate a JWT tokenhttps://developers.vtex.com/docs/api-reference/pick-and-pack-api post-/token to endpoint authentication. JSON Web Token JWT is an open standard RFC 7519 that dshipmentId (number)
X-PNP-FilterMethod (string) required
pick_and_pack/get_shipmentsLists all shipments by order ID. ℹ️ The endpoint supports up to 500 requests per second, with a maximum of 100 concurrent requests. ℹ️ Generate a JWT tokenhttps://developers.vtex.com/docs/api-reference/pick-and-pack-api post-/token to endpoint authentication. JSON Web Token JWT is an open standard RFC 7519 that defines a compact and self-contained way for securely transmitting information as a JSON object between parties. Permissions Any user or API keyhttps://developers.vtex.com/docorderId (string) required
pick_and_pack/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
pick_and_pack_last_mile_protocol/post_tokenCreates a JWT JSON Web Token necessary to access the Pick and Pack Last Mile Protocol API information. ℹ️ To generate the JWT it is necessary to have the API KEY previously generated by the Pick and Pack team. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
data: {
. apiKey (string)
} (object) required
pick_and_pack_last_mile_protocol/post_create_serviceCreates a service with the information that VTEX will send to the carrier. To understand how to integrate with a carrier, check the VTEX Pick and Pack Carriers Integration Protocolhttps://developers.vtex.com/docs/guides/vtex-pick-and-pack guide. This endpoint must be developed by the carriers or brokers to integrate into the protocol. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
Authorization (string) required
data: {
. orderId (string)
. carrierId (string)
. seller (string)
. sender (object)
. receiver (object)
. packages (array)
. carrierServiceType (string)
. type (string)
. paymentMethod (string)
. comments (string)
. orderValue (integer)
. settings (array)
. timezone
} (object) required
pick_and_pack_last_mile_protocol/post_ratesRetrieves all rates from the carriers. To understand how to integrate with a carrier, check the VTEX Pick and Pack Carriers Integration Protocolhttps://developers.vtex.com/docs/guides/vtex-pick-and-pack guide. This endpoint must be developed by the carriers or brokers to integrate into the protocol. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
Authorization (string) required
data: {
. orderId (string)
. carrierId (string)
. seller (string)
. sender (object)
. receiver (object)
. packages (array)
. carrierServiceType (string)
. type (string)
. paymentMethod (string)
. comments (string)
. orderValue (integer)
. settings (array)
. timezone
} (object) required
pick_and_pack_last_mile_protocol/post_list_carriersRetrieves all carriers from the broker. This endpoint must be developed by the carriers or brokers to integrate into the protocol. This endpoint only applies to multi-carrier integrations such as Shipstation or Shippo. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
Authorization (string) required
data: {
. settings (array)
} (object) required
pick_and_pack_last_mile_protocol/get_by_carrier_id_by_service_idReturns information about a service, which can be queried by providing the carrier ID and the corresponding service ID as query parameters. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.carrierId (string)
serviceId (string)
Content-Type (string) required
Accept (string) required
Authorization (string) required
pick_and_pack_last_mile_protocol/patch_by_carrier_id_by_service_idUpdates a service with the details of the tracking service via webhook. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.carrierId (string)
serviceId (string)
Content-Type (string) required
Accept (string) required
Authorization (string) required
data: {
. status (string)
. agent (string)
. trackingUrl (string)
. totalDistanceTraveled (string)
. rating (string)
. shippingPrice (string)
. shippingEstimatedDate (string)
} (object) required
pick_and_pack_last_mile_protocol/post_notes_by_carrier_id_by_service_idAllows carriers to add notes and information on existing services. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.carrierId (string)
serviceId (string)
Content-Type (string) required
Accept (string) required
Authorization (string) required
data (array) required
pick_and_pack_last_mile_protocol/post_evidences_by_carrier_id_by_service_idAllows the carrier to add evidence of delivery or pickup to the shipping service, as photos, text. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.carrierId (string)
serviceId (string)
Content-Type (string) required
Accept (string) required
Authorization (string) required
data (array) required
pick_and_pack_last_mile_protocol/post_labels_by_carrier_id_by_service_idAllows the carrier to create and add a shipping label to an order. It is important that the tag ID is a unique value, if this value is repeated it will throw an exception. ⚠️ If the label is type BASE64 or TXT, the max size that allowed is 180kb. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.carrierId (string)
serviceId (string)
Content-Type (string) required
Accept (string) required
Authorization (string) required
data: {
. id (string)
. url (string)
. name (string)
. type (string)
} (object) required
pick_and_pack_last_mile_protocol/post_cancel_by_carrier_id_by_service_idResquest that will cancel an ongoing shipping service. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.carrierId (string)
serviceId (string)
Content-Type (string) required
Accept (string) required
Authorization (string) required
data: {
. comment (string)
. type (string)
} (object) required
pick_and_pack_last_mile_protocol/post_cancel_serviceCancels a specific service. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
Authorization (string) required
data: {
. serviceId (string)
. carrierId (string)
. settings (array)
. reason (string)
. metaData (object)
} (object) required
pick_and_pack_last_mile_protocol/post_pause_servicePauses or resumes a paused service. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
Authorization (string) required
data: {
. serviceId (string)
. carrierId (string)
. pause (boolean)
. settings (array)
. reason (string)
. metaData (object)
} (object) required
pick_and_pack_last_mile_protocol/post_on_hold_by_carrier_id_by_service_idRequest that allows a carrier to temporarily pause a shipping service. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.carrierId (string)
serviceId (string)
Content-Type (string) required
Accept (string) required
Authorization (string) required
data: {
. comment (string)
. type (string)
} (object) required
pick_and_pack_last_mile_protocol/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
pick_and_pack_order_changes/put_orders_by_order_id_deadlineUpdates the deadline for an order. The min and max fields specify the deadline window, while the description provides additional information. ℹ️ This endpoint is currently in beta and subject to changes. Use with caution in production environments. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrorderId (string)
Accept (string) required
Content-Type (string) required
data: {
. description (string)
. max (string)
. min (string)
} (object) required
pick_and_pack_order_changes/post_order_changesThe endpoint supports actions like adding items, modifying quantities, rejecting or replacing items, and updating item details, adding notes and suggest product replacements. ℹ️ This endpoint is currently in beta and subject to changes. Use with caution in production environments. ⚠️ Before using this endpoint, you must make a request with the Cart simulationhttps://developers.vtex.com/docs/api-reference/checkout-api post-/api/checkout/pub/orderForms/simulation endpoint to check inventoryAccept (string) required
Content-Type (string) required
data (undefined) required
pick_and_pack_order_changes/get_by_sku_id_warehouses_by_warehouse_idRetrieves the BIN location for a specific SKU in a warehouse. The BIN location is a specific, designated storage location within a warehouse. This location isn't necessarily a physical container. Each BIN is typically assigned a unique identifier or code, facilitating precise tracking and retrieval of items within the warehouse. ℹ️ This endpoint is currently in beta and subject to changes. Use with caution in production environments. Permissions Any user or API keyhttps://developers.skuId (string)
warehouseId (string)
Accept (string) required
Content-Type (string) required
pick_and_pack_order_changes/post_by_sku_id_warehouses_by_warehouse_idCreates a new BIN location by warehouse ID and SKU ID. The BIN location is a specific, designated storage location within a warehouse. This location isn't necessarily a physical container. Each BIN is typically assigned a unique identifier or code, facilitating precise tracking and retrieval of items within the warehouse. ℹ️ This endpoint is currently in beta and subject to changes. Use with caution in production environments. Permissions Any user or API keyhttps://developers.vtex.coskuId (string)
warehouseId (string)
Accept (string) required
Content-Type (string) required
data: {
. location (string)
} (object) required
pick_and_pack_order_changes/put_by_sku_id_warehouses_by_warehouse_idUpdates the BIN location by warehouse ID and SKU ID. The BIN location is a specific, designated storage location within a warehouse. This location isn't necessarily a physical container. Each BIN is typically assigned a unique identifier or code, facilitating precise tracking and retrieval of items within the warehouse. ℹ️ This endpoint is currently in beta and subject to changes. Use with caution in production environments. Permissions Any user or API keyhttps://developers.vtex.com/skuId (string)
warehouseId (string)
Accept (string) required
Content-Type (string) required
data: {
. location (string)
} (object) required
pick_and_pack_order_changes/delete_by_sku_id_warehouses_by_warehouse_idDeletes a specific BIN location by warehouse ID and SKU ID. The BIN location is a specific, designated storage location within a warehouse. This location isn't necessarily a physical container. Each BIN is typically assigned a unique identifier or code, facilitating precise tracking and retrieval of items within the warehouse. ℹ️ This endpoint is currently in beta and subject to changes. Use with caution in production environments. Permissions Any user or API keyhttps://developers.vtskuId (string)
warehouseId (string)
Accept (string) required
Content-Type (string) required
pick_and_pack_order_changes/get_by_sku_id_warehousesRetrieves a list of warehouses associated with a specific SKU ID. The BIN location is a specific, designated storage location within a warehouse. This location isn't necessarily a physical container. Each BIN is typically assigned a unique identifier or code, facilitating precise tracking and retrieval of items within the warehouse. ℹ️ This endpoint is currently in beta and subject to changes. Use with caution in production environments. Permissions Any user or API keyhttps://developskuId (string)
Accept (string) required
Content-Type (string) required
pick_and_pack_order_changes/delete_by_sku_id_warehousesDeletes all BIN locations for a specific SKU ID. The BIN location is a specific, designated storage location within a warehouse. This location isn't necessarily a physical container. Each BIN is typically assigned a unique identifier or code, facilitating precise tracking and retrieval of items within the warehouse. ℹ️ This endpoint is currently in beta and subject to changes. Use with caution in production environments. Permissions Any user or API keyhttps://developers.vtex.com/docsskuId (string)
Accept (string) required
Content-Type (string) required
pick_and_pack_order_changes/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
policies_system/get_api_policy_engine_policiesRetrieves a list of all policies in the account and general information of each policy. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoContent-Type (string) required
Accept (string) required
policies_system/post_api_policy_engine_evaluateThis endpoint consults all policies and checks the ones that satisfy the request body’s conditions. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources foContent-Type (string) required
Accept (string) required
data: {
. resource (string)
. context (object)
} (object) required
policies_system/get_api_policy_engine_policies_by_idRetrieves general information of a policy by its ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resoid (string)
Content-Type (string) required
Accept (string) required
policies_system/post_api_policy_engine_policies_by_idCreates a new policy from scratch. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --------id (string)
Content-Type (string) required
Accept (string) required
data: {
. name (string)
. description (string)
. status (string)
. statements (array)
} (object) required
policies_system/put_api_policy_engine_policies_by_idUpdates an existing policy at your account. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | |id (string)
Content-Type (string) required
Accept (string) required
data: {
. name (string)
. description (string)
. status (string)
. statements (array)
} (object) required
policies_system/delete_api_policy_engine_policies_by_idDeletes a specific policy of the account by its ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resouid (string)
Content-Type (string) required
Accept (string) required
policies_system/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
pricing/get_pricing_prices_by_item_idRetrieves price data given a specific SKU ID. Within the fixedPrices object, there might be a list of prices for specific Trade Policies and Minimium Quantities of the SKU. Fixed Prices may also be scheduled. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfitemId (integer)
Content-Type (string) required
Accept (string) required
pricing/delete_pricing_prices_by_item_idDeletes the Base Price and all available Fixed Prices for an SKU in all trade policies. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoitemId (integer)
Content-Type (string) required
Accept (string) required
pricing/put_pricing_prices_by_item_idCreates or updates an SKU base price or fixed price. The base price is the basic selling price of a product, it comprises the cost price and the markup wanted in the sale of the product. The fixed price is an optional price of the SKU for a specific trade policy with a specific minimum quantity to be activated. You may optionally set a list price. You must provide exactly two values among basePrice, costPrice, and markup. If all three are sent at the same time, the request will fail. If you pitemId (integer)
Content-Type (string) required
Accept (string) required
data: {
. markup (integer)
. listPrice (number)
. basePrice (number)
. costPrice (number)
. fixedPrices (array)
} (object) required
pricing/get_pricing_prices_by_item_id_fixedThe fixed price is an optional price of the SKU for a specific trade policy with a specific minimum quantity to be activated. This method retrieves an array of fixed prices for a SKU in a trade policy with minimum quantities. The default value for a minimum quantity is 1. This means a fixed price will be valid for a SKU in a trade policy for orders containing the specified number of minimum quantity or above, unless a higher minimum quantity is specified. Fixed prices may, optionally, be sitemId (integer)
Content-Type (string) required
Accept (string) required
pricing/patch_pricing_prices_by_item_id_fixedUpdates the base price or fixed prices of an SKU. The base price is the basic selling price of a product, it comprises the cost price and the markup wanted in the sale of the product. A fixed price is an optional price defined for a specific trade policy or a price table. It can include a minimum quantity and an effective date range that determines when the price is active. This request does not remove existing prices. Instead, it updates or adds new prices without affecting trade policies oritemId (integer)
Content-Type (string) required
Accept (string) required
data (array) required
pricing/post_pricing_prices_by_item_id_fixed_by_price_table_idCreates or updates the fixed prices of an SKU for a specific price table or trade policy. You can add one or multiple fixed prices per SKU. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 erroitemId (integer)
priceTableId (string)
Content-Type (string) required
Accept (string) required
data (array) required
pricing/get_pricing_prices_by_item_id_fixed_by_price_table_idRetrieves all Fixed Prices on a price table or trade policy. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | CateitemId (integer)
priceTableId (string)
Content-Type (string) required
Accept (string) required
pricing/delete_pricing_prices_by_item_id_fixed_by_price_table_idDeletes all Fixed Prices of an SKU in a specific Price Table or Trade Policy. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: |itemId (integer)
priceTableId (string)
Content-Type (string) required
Accept (string) required
pricing/get_pricing_prices_by_item_id_computedRetrieves the computed prices for an SKU across all price tables that have a fixed price configured. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources fitemId (integer)
Content-Type (string) required
Accept (string) required
categoryIds (integer)
brandId (integer)
quantity (integer)
pricing/get_pricing_prices_by_item_id_computed_by_price_table_idGets the Computed Price, which is the price after all the steps in the Pricing pipeline, for an SKU in a specific price table or trade policy. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403itemId (integer)
priceTableId (string)
Content-Type (string) required
Accept (string) required
categoryIds (integer)
brandId (integer)
quantity (integer)
pricing/get_pricing_configRetrieves Pricing configuration. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --------Content-Type (string) required
Accept (string) required
pricing/get_pricing_migrationRetrieves Pricing v2 status. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --------------Content-Type (string) required
Accept (string) required
pricing/get_pricing_pipeline_catalog_by_price_table_idRetrieves the rules of a specific price table. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResourcepriceTableId (string)
Content-Type (string) required
Accept (string) required
pricing/put_pricing_pipeline_catalog_by_price_table_idUpdates the rules of a specific price table, by deleting all the rules from the requested price table and creating new rules based on the content of the request. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receivpriceTableId (string)
Content-Type (string) required
Accept (string) required
data: {
. rules (array)
} (object) required
pricing/put_pricing_tables_by_price_table_idCreate a new price table. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | ---------------priceTableId (string)
Content-Type (string) required
Accept (string) required
pricing/get_pricing_pipeline_catalogRetrieves a list of all price tables and their rules. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | RContent-Type (string) required
Accept (string) required
pricing/get_pricing_tablesRetrieves a list of all price tables. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -----Content-Type (string) required
Accept (string) required
pricing/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
pricing_hub/post_api_pricing_hub_prices⚠️ This API has been deprecated. If you need to associate prices with specific customers, we recommend using the Audience APIhttps://developers.vtex.com/docs/api-reference/audience-api. This route retrieves and applies prices for the items that are passed in the request. Pricing Hub will select the pricing method that will be used for each item and will fetch their respective price from the selected pricing method.an (string) required
data: {
. items
. UtmSource (string)
. UtmMedium (string)
. UtmCampaign (string)
. UtmInternalCampaign (string)
. salesChannel (string)
. email (string)
} (object) required
pricing_hub/put_api_pricing_hub_prices_config⚠️ This API has been deprecated. If you need to associate prices with customers, we recommend using the Audience APIhttps://developers.vtex.com/docs/api-reference/audience-api. This route facilitates setting up an external price source in Pricing Hub. It also allows you to activate or deactivate that source in a given account.an (string)
data: {
. active (boolean)
. appName (string)
} (object) required
pricing_hub/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
profile_system/post_api_storage_profile_system_profilesCreates new client profile. You can send custom fields in the request body and they will be saved as part of your document. Therefore, the schema and examples presented below may differ from yours. Your integration must be adapted accordingly. The id field returned by this request is the profileId used to retrieve information on a specific profile later. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ ThContent-Type (string) required
Accept (string) required
ttl (integer)
data: {
. firstName (string)
. lastName (string)
. email (string)
. birthDate (string)
. document (string)
. documentType (string)
. customField (string)
} (object) required
profile_system/get_api_storage_profile_system_profiles_by_profile_idRetrieves the information of a specific client, by its profileId. Since your store's profile schema is customizable, the schema and examples presented below may differ from yours. Your integration must be adapted accordingly. For security and privacy reasons, this request returns masked profile data. For unmasked information, see Get unmasked profilehttps://developers.vtex.com/docs/api-reference/profile-system get-/api/storage/profile-system/profiles/-profileId-/unmask. Learn more aboprofileId (string)
Content-Type (string) required
Accept (string) required
alternativeKey (string)
profile_system/patch_api_storage_profile_system_profiles_by_profile_idUpdates one or more fields of an existing client profile. Since your store's profile schema is customizable, the schema and examples presented below may differ from yours. Your integration must be adapted accordingly. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vtex.com/docs/guiprofileId (string)
Content-Type (string) required
Accept (string) required
alternativeKey (string)
ttl (integer)
data: {
. firstName (string)
. lastName (string)
. email (string)
. birthDate (string)
. document (string)
. documentType (string)
. customField (string)
} (object) required
profile_system/delete_api_storage_profile_system_profiles_by_profile_idDeletes a client profile by profileId. ❗ This endpoint is not suitable for granting a shopper's right to erasurehttps://help.vtex.com/en/tutorial/data-subject-rights--6imchxTx09icupKMbzHVIM erasure. For that purpose, open a supporthttps://help.vtex.com/en/support ticket, according to the instructions in the section Request erasure via supporthttps://help.vtex.com/en/tutorial/erasing-customer-data--1R9Fn7A06Ifj4R9YD4JTKU request-erasure-via-support of the shopper data erasure guide. Learn mprofileId (string)
Content-Type (string) required
Accept (string) required
profile_system/get_api_storage_profile_system_profiles_by_profile_id_unmaskRetrieves unmasked information of a specific client, by its profileId. Since your store's profile schema is customizable, the schema and examples presented below may differ from yours. Your integration must be adapted accordingly. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vtexprofileId (string)
Content-Type (string) required
Accept (string) required
reason (string) required
alternativeKey (string)
profile_system/get_api_storage_profile_system_profiles_by_profile_id_versions_by_profile_version_idRetrieves the information of a specific version of a client profile. Since your store's profile schema is customizable, the schema and examples presented below may differ from yours. Your integration must be adapted accordingly. For security and privacy reasons, this request returns masked profile data. For unmasked information, see Get unmasked profile by versionhttps://developers.vtex.com/docs/api-reference/profile-system get-/api/storage/profile-system/profiles/-profileId-/versions/-pprofileId (string)
profileVersionId (string)
Content-Type (string) required
Accept (string) required
profile_system/get_api_storage_profile_system_profiles_by_profile_id_versions_by_profile_version_id_unmaskRetrieves unmasked information of a specific version of a client profile. Since your store's profile schema is customizable, the schema and examples presented below may differ from yours. Your integration must be adapted accordingly. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vprofileId (string)
profileVersionId (string)
Content-Type (string) required
Accept (string) required
reason (string) required
profile_system/post_api_storage_profile_system_profiles_by_profile_id_addressesCreates new address for a given client profile. The id field returned by this request is the addressId used to retrieve or update information of a specific address later. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vtex.com/docs/guides/data-protection-plus, which is in closed beprofileId (string)
Content-Type (string) required
Accept (string) required
alternativeKey (string)
data: {
. postalCode (string)
. countryName (string)
. countryCode (string)
. administrativeAreaLevel1 (string)
. locality (string)
. localityAreaLevel1 (string)
. route (string)
. streetNumber (string)
. contactId (string)
} (object) required
profile_system/get_api_storage_profile_system_profiles_by_profile_id_addressesRetrieves information of all addresses of a given client, by its profileId. For security and privacy reasons, this request returns masked address data. For unmasked information, see Get unmasked client addresseshttps://developers.vtex.com/docs/api-reference/profile-system get-/api/storage/profile-system/profiles/-profileId-/addresses/unmask. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile SysteprofileId (string)
Content-Type (string) required
Accept (string) required
alternativeKey (string)
profile_system/get_api_storage_profile_system_profiles_by_profile_id_addresses_unmaskRetrieves unmasked information of all addresses of a given client, by its profileId. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vtex.com/docs/guides/data-protection-plus, which is in closed beta phase, only available in select regions. This feature is part of VTEX Shieldhttps:/profileId (string)
Content-Type (string) required
Accept (string) required
alternativeKey (string)
profile_system/get_api_storage_profile_system_profiles_by_profile_id_addresses_by_address_idRetrieves information of a specific address of a given client, by its respectives adderssId and profileId. For security and privacy reasons, this request returns masked address data. For unmasked information, see Get unmasked addresshttps://developers.vtex.com/docs/api-reference/profile-system get-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-/unmask. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other APIprofileId (string)
addressId (string)
Content-Type (string) required
Accept (string) required
alternativeKey (string)
profile_system/patch_api_storage_profile_system_profiles_by_profile_id_addresses_by_address_idUpdates one or more fields of an existing address for a given client profile. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vtex.com/docs/guides/data-protection-plus, which is in closed beta phase, only available in select regions. This feature is part of VTEX Shieldhttps://help.vprofileId (string)
addressId (string)
Content-Type (string) required
Accept (string) required
alternativeKey (string)
data: {
. postalCode (string)
. countryName (string)
. countryCode (string)
. administrativeAreaLevel1 (string)
. locality (string)
. localityAreaLevel1 (string)
. route (string)
. streetNumber (string)
. contactId (string)
} (object) required
profile_system/delete_api_storage_profile_system_profiles_by_profile_id_addresses_by_address_idDeletes a client's address by profileId and addressId. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vtex.com/docs/guides/data-protection-plus, which is in closed beta phase, only available in select regions. This feature is part of VTEX Shieldhttps://help.vtex.com/en/tutorial/vteprofileId (string)
addressId (string)
Content-Type (string) required
Accept (string) required
alternativeKey (string)
profile_system/get_api_storage_profile_system_profiles_by_profile_id_addresses_by_address_id_unmaskRetrieves unmasked information of a specific address of a given client, by its respectives adderssId and profileId. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vtex.com/docs/guides/data-protection-plus, which is in closed beta phase, only available in select regions. This featurprofileId (string)
addressId (string)
Content-Type (string) required
Accept (string) required
reason (string) required
alternativeKey (string)
profile_system/get_api_storage_profile_system_profiles_by_profile_id_addresses_by_address_id_versions_by_address_version_idRetrieves information of a specific version address of a given client. For security and privacy reasons, this request returns masked address data by version. For unmasked information, see Get unmasked address by versionhttps://developers.vtex.com/docs/api-reference/profile-system get-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-/versions/-addressVersionId-/unmask. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system andprofileId (string)
addressId (string)
addressVersionId (string)
Content-Type (string) required
Accept (string) required
reason (string) required
alternativeKey (string)
profile_system/get_api_storage_profile_system_profiles_by_profile_id_addresses_by_address_id_versions_by_address_version_id_unmaskRetrieves unmasked information of a specific address version of a given client. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vtex.com/docs/guides/data-protection-plus, which is in closed beta phase, only available in select regions. This feature is part of VTEX Shieldhttps://helpprofileId (string)
addressId (string)
addressVersionId (string)
Content-Type (string) required
Accept (string) required
reason (string) required
alternativeKey (string)
profile_system/post_api_storage_profile_system_prospectsCreates new prospect. The id field returned by this request is the prospectId used to retrieve information on a specific prospect later. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vtex.com/docs/guides/data-protection-plus, which is in closed beta phase, only available in selectContent-Type (string) required
Accept (string) required
data: {
. availableAddresses (array)
. paymentData
. contacts (array)
. invoiceSubject (object)
. email (string)
. firstName (string)
. lastName (string)
. document (string)
. cellPhone (string)
. isPJ (boolean)
. customerCode (string)
} (object) required
profile_system/get_api_storage_profile_system_prospectsRetrieves information of all prospects. For security and privacy reasons, this request returns masked prospect data. For unmasked information, see Get unmasked prospectshttps://developers.vtex.com/docs/api-reference/profile-system get-/api/storage/profile-system/prospects/unmask. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecturContent-Type (string) required
Accept (string) required
profile_system/get_api_storage_profile_system_prospects_unmaskRetrieves unmasked information of all prospects. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vtex.com/docs/guides/data-protection-plus, which is in closed beta phase, only available in select regions. This feature is part of VTEX Shieldhttps://help.vtex.com/en/tutorial/vtex-shieContent-Type (string) required
Accept (string) required
profile_system/get_api_storage_profile_system_prospects_by_prospect_idRetrieves the information of a specific prospect, by its prospectId. For security and privacy reasons, this request returns masked prospect data. For unmasked information, see Get unmasked prospecthttps://developers.vtex.com/docs/api-reference/profile-system get-/api/storage/profile-system/prospects/-prospectId-/unmask. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible wprospectId (string)
Content-Type (string) required
Accept (string) required
profile_system/patch_api_storage_profile_system_prospects_by_prospect_idUpdates one or more fields of an existing prospect. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vtex.com/docs/guides/data-protection-plus, which is in closed beta phase, only available in select regions. This feature is part of VTEX Shieldhttps://help.vtex.com/en/tutorial/vtex-sprospectId (string)
Content-Type (string) required
Accept (string) required
data: {
. availableAddresses (array)
. paymentData
. contacts (array)
. invoiceSubject (object)
. email (string)
. firstName (string)
. lastName (string)
. document (string)
. cellPhone (string)
. isPJ (boolean)
. customerCode (string)
} (object) required
profile_system/delete_api_storage_profile_system_prospects_by_prospect_idDeletes a prospect by prospectId. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vtex.com/docs/guides/data-protection-plus, which is in closed beta phase, only available in select regions. This feature is part of VTEX Shieldhttps://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CprospectId (string)
Content-Type (string) required
Accept (string) required
profile_system/get_api_storage_profile_system_prospects_by_prospect_id_unmaskRetrieves unmasked information of a specific prospect, by its prospectId. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vtex.com/docs/guides/data-protection-plus, which is in closed beta phase, only available in select regions. This feature is part of VTEX Shieldhttps://help.vtex.prospectId (string)
Content-Type (string) required
Accept (string) required
reason (string) required
profile_system/post_api_storage_profile_system_profiles_by_profile_id_purchase_infoCreates purchase information for a given client profile. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vtex.com/docs/guides/data-protection-plus, which is in closed beta phase, only available in select regions. This feature is part of VTEX Shieldhttps://help.vtex.com/en/tutorial/vprofileId (string)
Content-Type (string) required
Accept (string) required
alternativeKey (string)
data: {
. paymentData
. clientPreferences (object)
. isToSavePersonalData (boolean)
. lastUserPurchases (array)
. lastPurchasesAddressId (string)
} (object) required
profile_system/get_api_storage_profile_system_profiles_by_profile_id_purchase_infoRetrieves purchase information of a given client, by its profileId. For security and privacy reasons, this request returns masked data. For unmasked information, see Get unmasked purchase informationhttps://developers.vtex.com/docs/api-reference/profile-system get-/api/storage/profile-system/profiles/-profileId-/purchase-info/unmask. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is onlprofileId (string)
Content-Type (string) required
Accept (string) required
alternativeKey (string)
profile_system/patch_api_storage_profile_system_profiles_by_profile_id_purchase_infoUpdates one or more fields of existing purchase information for a given client profile. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vtex.com/docs/guides/data-protection-plus, which is in closed beta phase, only available in select regions. This feature is part of VTEX ShieldhttpprofileId (string)
Content-Type (string) required
Accept (string) required
alternativeKey (string)
data: {
. paymentData
. clientPreferences (object)
. isToSavePersonalData (boolean)
. lastUserPurchases (array)
. lastPurchasesAddressId (string)
} (object) required
profile_system/delete_api_storage_profile_system_profiles_by_profile_id_purchase_infoDeletes purchase informaiton by profileId. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vtex.com/docs/guides/data-protection-plus, which is in closed beta phase, only available in select regions. This feature is part of VTEX Shieldhttps://help.vtex.com/en/tutorial/vtex-shield--2CprofileId (string)
Content-Type (string) required
Accept (string) required
alternativeKey (string)
profile_system/get_api_storage_profile_system_profiles_by_profile_id_purchase_info_unmaskRetrieves unmasked purchase information of a given client, by its profileId. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vtex.com/docs/guides/data-protection-plus, which is in closed beta phase, only available in select regions. This feature is part of VTEX Shieldhttps://help.vtprofileId (string)
Content-Type (string) required
Accept (string) required
reason (string) required
profile_system/get_api_storage_profile_system_schemas_profile_systemRetrieves the full profile schema, including custom fields. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vtex.com/docs/guides/data-protection-plus, which is in closed beta phase, only available in select regions. This feature is part of VTEX Shieldhttps://help.vtex.com/en/tutoriaContent-Type (string) required
Accept (string) required
profile_system/put_api_storage_profile_system_schemas_profile_system_customCreates or deletes custom fields in the profile schema. To create custom fields, include a request body. To delete all custom fields, pass an empty JSON. Each account has one profile schema. Updating it with this request will substitute the previous version. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data ProtectioContent-Type (string) required
Accept (string) required
data (undefined) required
profile_system/get_api_storage_profile_system_schemas_profile_system_customRetrieves all custom fields in the profile schema. Learn more about the Profile Systemhttps://developers.vtex.com/vtex-rest-api/docs/profile-system and its other API endpoints. ⚠️ The Profile System is only compatible with stores using the PII data architecture from Data Protection Plushttps://developers.vtex.com/docs/guides/data-protection-plus, which is in closed beta phase, only available in select regions. This feature is part of VTEX Shieldhttps://help.vtex.com/en/tutorial/vtex-shContent-Type (string) required
Accept (string) required
profile_system/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
promotions_taxes_api_v2/get_api_rnb_v2_pvt_couponRetrieves the list of all active coupons. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -No parameters
promotions_taxes_api_v2/get_api_rnb_v2_pvt_coupon_group_archivedRetrieves the list of all archived coupons. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | |No parameters
promotions_taxes_api_v2/get_api_rnb_v2_pvt_coupon_group_by_grouping_keyRetrieves information from a specific coupon batch based on its groupingKey. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | PgroupingKey (string)
promotions_taxes_api_v2/put_api_rnb_v2_pvt_coupon_group_by_grouping_keyChanges information from a specific coupon batch configuration based on its groupingKey. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpgroupingKey (string)
data: {
. utmSource (string)
. utmCampaign (string)
. isArchived (boolean)
. maxItemsPerClient (number)
. expirationIntervalPerUse (string)
. maxUsage (number)
} (object) required
promotions_taxes_api_v2/get_api_rnb_v2_pvt_coupon_group_by_grouping_key_codesRetrieves a specific coupon batch's list of codes. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResourgroupingKey (string)
promotions_taxes_api_v2/put_api_rnb_v2_pvt_coupon_group_by_grouping_key_archiveArchives a coupon batch and its respective codes. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResourcgroupingKey (string)
promotions_taxes_api_v2/post_api_rnb_v2_pvt_coupon_groupCreates one or more coupon batches. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -------data (array) required
promotions_taxes_api_v2/put_api_rnb_v2_pvt_coupon_group_by_grouping_key_unarchiveUnarchives a coupon batch and its respective codes. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResougroupingKey (string)
promotions_taxes_api_v2/get_api_rnb_v2_pvt_coupon_usage_count_by_coupon_codeReturns the number of times a specific single coupon was used, based on its couponCode. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpocouponCode (string)
promotions_taxes_api_v2/get_api_rnb_v2_pvt_coupon_usage_count_group_by_grouping_keyReturns the number of times a coupon batch was used, based on its groupingKey. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: |groupingKey (string)
promotions_taxes_api_v2/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
promotions_taxes/post_api_rnb_pvt_multiple_couponsCreates multiple coupons with different coupon codes. This endpoint has a throttling of 60 requests per minute. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicabledata (array) required
promotions_taxes/post_api_rnb_pvt_couponCreates a new single coupon or updates an existing coupon. To update an existing coupon, first make a Get coupon by coupon codehttps://developers.vtex.com/docs/api-reference/promotions-and-taxes-api get-/api/rnb/pvt/coupon/-couponCode- request, copy the response body and apply the desired changes. Then, use the complete edited body as a request body in this update call. ⚠️ When updating a coupon, don't change the original couponCode, or a new coupon will be created instead of the existingdata: {
. utmSource (string)
. utmCampaign (string)
. couponCode (string)
. isArchived (boolean)
. maxItemsPerClient (integer)
. expirationIntervalPerUse (string)
. maxUsage (integer)
} (object) required
promotions_taxes/get_api_rnb_pvt_couponCheck the new Promotions onboarding guidehttps://developers.vtex.com/vtex-rest-api/docs/promotions-overview. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Promotions and is organized by focusing on the developer's journey. Retrieves all coupons from an account. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least oneNo parameters
promotions_taxes/get_api_rnb_pvt_coupon_by_coupon_codeRetrieves a specific coupon by its coupon code. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResourcecouponCode (string)
promotions_taxes/get_api_rnb_pvt_archive_coupon_by_coupon_codeRetrieves a specific archived coupon by its coupon code. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category |couponCode (string)
promotions_taxes/post_api_rnb_pvt_archive_coupon_by_coupon_codeArchives a specific coupon by its coupon code. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource |couponCode (string)
promotions_taxes/post_api_rnb_pvt_couponsGenerates a massive amount of coupons. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | ----quantity (integer) required
data: {
. utmSource (string)
. utmCampaign (string)
. couponCode (string)
. maxItemsPerClient (integer)
. expirationIntervalPerUse (string)
} (object) required
promotions_taxes/get_api_rnb_pvt_coupon_usage_by_coupon_codeRetrieves information about the coupon usage. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource |couponCode (string)
promotions_taxes/post_api_rnb_pvt_unarchive_coupon_by_coupon_codeUnarchives a specifc coupon by its coupon code. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | ResourcecouponCode (string)
promotions_taxes/get_api_rnb_pvt_benefits_calculatorconfigurationRetrieves all promotions from an account. 📘 Onboarding guide Check the new Promotions onboarding guidehttps://developers.vtex.com/vtex-rest-api/docs/promotions-overview. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about the Promotions and is organized by focusing on the developer's journey. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-No parameters
promotions_taxes/get_api_rnb_pvt_benefits_calculatorconfiguration_searchRetrieves all promotions whose name contains the searched term. 📘 Onboarding guide Check the new Promotions onboarding guidehttps://developers.vtex.com/vtex-rest-api/docs/promotions-overview. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about the Promotions and is organized by focusing on the developer's journey. Permissions Any user or API keyhttps://developers.vtex.com/docs/guidbyName (string) required
promotions_taxes/get_api_rnb_pvt_taxes_calculatorconfigurationRetrieves all taxes from an account. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | ------No parameters
promotions_taxes/get_api_rnb_pvt_calculatorconfiguration_by_id_calculator_configurationRetrieves a specific promotion by its Promotion ID or a specific tax by its tax ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:idCalculatorConfiguration (string)
promotions_taxes/post_api_rnb_pvt_calculatorconfiguration_by_promotion_id_seller_optAdds or removes one or more sellers to or from a specified promotion. ⚠️ When the first seller opts in to an inactive promotion, it's activated, and when the last seller opts out, it's deactivated. Permissions Any user or application keyhttps://developers.vtex.com/docs/guides/api-authentication-using-application-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to supromotionId (string)
an (string) required
if-Match (string) required
data: {
. sellerIds (array)
. operation (string)
} (object) required
promotions_taxes/post_api_rnb_pvt_calculatorconfigurationCreates or updates a specific Promotion by its Promotion ID or a specific tax by its tax ID. ⚠️ You should always include both the id and name when registering objects in the request body. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this requestdata: {
. idCalculatorConfiguration (string)
. name (string)
. description (string)
. beginDateUtc (string)
. endDateUtc (string)
. lastModified (string)
. daysAgoOfPurchases (integer)
. isActive (boolean)
. isArchived (boolean)
. isFeatured (boolean)
. disableDeal (boolean)
. activeDaysOfWeek (array)
. offset (integer)
. activateGiftsMultiplier (boolean)
. newOffset (number)
. maxPricesPerItems (array)
. cumulative (boolean)
. discountType (string)
. nominalShippingDiscountValue (number)
. absoluteShippingDiscountValue (number)
. nominalDiscountValue (number)
. nominalDiscountType (string)
. maximumUnitPriceDiscount (number)
. percentualDiscountValue (number)
. rebatePercentualDiscountValue (number)
. percentualShippingDiscountValue (number)
. percentualTax (number)
. shippingPercentualTax (number)
. percentualDiscountValueList1 (number)
. percentualDiscountValueList2 (number)
. skusGift (object)
. nominalRewardValue (number)
. percentualRewardValue (number)
. orderStatusRewardValue (string)
. maxNumberOfAffectedItems (integer)
. maxNumberOfAffectedItemsGroupKey (string)
. applyToAllShippings (boolean)
. nominalTax (number)
. origin (string)
. idSeller (string)
. idSellerIsInclusive (boolean)
. idsSalesChannel (array)
. areSalesChannelIdsExclusive (boolean)
. marketingTags (array)
. marketingTagsAreNotInclusive (boolean)
. paymentsMethods (array)
. stores (array)
. campaigns (array)
. conditionsIds (array)
. storesAreInclusive (boolean)
. categories (array)
. categoriesAreInclusive (boolean)
. brands (array)
. brandsAreInclusive (boolean)
. products (array)
. productsAreInclusive (boolean)
. skus (array)
. skusAreInclusive (boolean)
. utmSource (string)
. utmCampaign (string)
. collections1BuyTogether (array)
. collections2BuyTogether (array)
. minimumQuantityBuyTogether (integer)
. quantityToAffectBuyTogether (integer)
. enableBuyTogetherPerSku (boolean)
. listSku1BuyTogether (array)
. listSku2BuyTogether (array)
. coupon (array)
. totalValueFloor (number)
. totalValueCeling (number)
. totalValueIncludeAllItems (boolean)
. totalValueMode (string)
. collections (array)
. collectionsIsInclusive (boolean)
. restrictionsBins (array)
. cardIssuers (array)
. totalValuePurchase (number)
. slasIds (array)
. isSlaSelected (boolean)
. isFirstBuy (boolean)
. firstBuyIsProfileOptimistic (boolean)
. compareListPriceAndPrice (boolean)
. isDifferentListPriceAndPrice (boolean)
. zipCodeRanges (array)
. itemMaxPrice (number)
. itemMinPrice (number)
. installment (integer)
. isMinMaxInstallments (boolean)
. minInstallment (integer)
. maxInstallment (integer)
. merchants (array)
. clusterExpressions (array)
. paymentsRules (array)
. giftListTypes (array)
. productsSpecifications (array)
. affiliates (array)
. maxUsage (integer)
. maxUsagePerClient (integer)
. shouldDistributeDiscountAmongMatchedItems (boolean)
. multipleUsePerClient (boolean)
. accumulateWithManualPrice (boolean)
. type (string)
. useNewProgressiveAlgorithm (boolean)
. percentualDiscountValueList (array)
. optIn (object)
} (object) required
promotions_taxes/post_api_rnb_pvt_import_calculator_configurationCreates a Multiple SKU promotion. This scenario allows the creation of a single promotion for multiples SKUs with the Percentage Effect. ⚠️ The limit of SKUs on a Multiple Effects promotion is 400. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run thisX-VTEX-calculator-name (string) required
X-VTEX-cumulative (boolean)
X-VTEX-cluster-operator (string)
X-VTEX-cluster-expression (string)
X-VTEX-start-date (string) required
X-VTEX-end-date (string) required
X-VTEX-accumulate-with-manual-prices (boolean) required
promotions_taxes/put_api_rnb_pvt_import_calculator_configuration_by_promotion_idUpdates information from a Multiple SKU promotion. This scenario allows the creation of a single promotion for multiple SKUs with the Percentage Effect. ⚠️ The limit of SKUs on a Multiple Effects promotion is 400. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to succpromotionId (string)
X-VTEX-calculator-name (string) required
X-VTEX-cumulative (boolean)
X-VTEX-cluster-operator (string)
X-VTEX-cluster-expression (string)
X-VTEX-start-date (string) required
X-VTEX-end-date (string) required
X-VTEX-accumulate-with-manual-prices (boolean) required
promotions_taxes/post_api_rnb_pvt_archive_calculator_configuration_by_id_calculator_configurationArchives a promotion or tax by its ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | ----idCalculatorConfiguration (string)
promotions_taxes/post_api_rnb_pvt_unarchive_calculator_configuration_by_id_calculator_configurationUnarchives a promotion or tax by its ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --idCalculatorConfiguration (string)
promotions_taxes/get_api_rnb_pvt_archive_benefits_calculator_configurationLists all archived promotions. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | ------------No parameters
promotions_taxes/get_api_rnb_pvt_archive_taxes_calculator_configurationLists all archived taxes. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --------------- |No parameters
promotions_taxes/get_price_sheet_by_sku_idRetrieve price given an SKU ID. If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the Pricing v2 APIhttps://developers.vtex.com/docs/api-reference/pricing-api Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfullyskuId (string)
an (string) required
promotions_taxes/delete_price_sheet_by_sku_idDelete all prices from an SKU. If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the Pricing v2 APIhttps://documenter.getpostman.com/view/101975/vtex-pricing-api/6YsWxKT If you are still using Pricing v1, please check if your store is able to migrate to take advantage of many more featureshttps://help.vtex.com/en/faq/how-to-migrate-a-store-to-pricing-v2 Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authenskuId (string)
an (string) required
promotions_taxes/get_price_sheet_all_by_page_by_page_sizeGet all paged prices. If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the Pricing v2 APIhttps://documenter.getpostman.com/view/101975/vtex-pricing-api/6YsWxKT If you are still using Pricing v1, please check if your store is able to migrate to take advantage of many more featureshttps://help.vtex.com/en/faq/how-to-migrate-a-store-to-pricing-v2 Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-page (string)
pageSize (string)
an (string) required
promotions_taxes/post_price_sheet_contextGet price by context. If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the Pricing v2 APIhttps://documenter.getpostman.com/view/101975/vtex-pricing-api/6YsWxKT If you are still using Pricing v1, please check if your store is able to migrate to take advantage of many more featureshttps://help.vtex.com/en/faq/how-to-migrate-a-store-to-pricing-v2 Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-an (string) required
data: {
. id (integer)
. itemId (integer)
. salesChannel (integer)
. sellerId (string)
. validFrom (string)
. validTo (string)
} (object) required
promotions_taxes/get_price_sheet_by_sku_id_by_trade_policyRetrieve price by SKU ID and trade policy. If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the Pricing v2 APIhttps://documenter.getpostman.com/view/101975/vtex-pricing-api/6YsWxKT If you are still using Pricing v1, please check if your store is able to migrate to take advantage of many more featureshttps://help.vtex.com/en/faq/how-to-migrate-a-store-to-pricing-v2 Permissions Any user or API keyhttps://developers.vtex.com/docs/guideskuId (string)
tradePolicy (string)
an (string) required
promotions_taxes/post_price_sheetSave price. If your account is using Pricing v2, you should avoid using these routes. Please refer directly to the Pricing v2 APIhttps://documenter.getpostman.com/view/101975/vtex-pricing-api/6YsWxKT If you are still using Pricing v1, please check if your store is able to migrate to take advantage of many more featureshttps://help.vtex.com/en/faq/how-to-migrate-a-store-to-pricing-v2 Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-an (string) required
data (array) required
promotions_taxes/post_pub_bundlesCalculate discounts and taxes Permissions This endpoint is usually used internally for backend services and does not require user permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.data: {
. isShoppingCart (boolean)
. origin (string)
. salesChannel (string)
. profileId (string)
. items (array)
} (object) required
promotions_taxes/get_api_rnb_pvt_campaign_configuration_by_campaign_idRetrieves a specific campaign audience configuration by its ID. This API uses the campaign ID, not the campaign name. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicampaignId (string)
promotions_taxes/get_api_rnb_pvt_campaign_configurationRetrieves a list of all campaign audiences and their respective configurations. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:No parameters
promotions_taxes/post_api_rnb_pvt_campaign_configurationCreates a new campaign audience. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | ----------data: {
. beginDateUtc (string)
. endDateUtc (string)
. id (string)
. name (string)
. isActive (boolean)
. isAndOperator (boolean)
. isArchived (boolean)
. lastModified (object)
. targetConfigurations (array)
} (object) required
promotions_taxes/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
punchout/post_api_authenticator_punchout_startInitiates punchout authentication for an existing VTEX user. This endpoint validates the credentials against the VTEX user database. If validation succeeds, it returns a URL containing a one-time token that can be accessed via web browser to start an authenticated session. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
returnURL (string)
data: {
. username (string)
. password (string)
} (object) required
punchout/post_api_authenticator_punchout_authenticated_startInitiates punchout authentication for a pre-authenticated user who doesn't exist in VTEX. This endpoint must be called with valid API key/token credentials associated with a role with the CanPunchout permission. No password validation is performed as the caller is pre-authenticated. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have the appropriate License Manager resourcehttps://help.vtex.com/en/tutorial/license-manager-resContent-Type (string) required
Accept (string) required
returnURL (string)
data: {
. username (string)
} (object) required
punchout/get_api_authenticator_punchout_finishExchanges the one-time token OTT for VTEX session cookies and completes the authentication process. In browser-based integrations, this flow happens automatically when the user's browser accesses the URL returned by the start endpoint. For headless operations where no browser is involved, integrators must explicitly call this endpoint to obtain the necessary authentication cookies. This endpoint: - Validates the OTT checks existence, expiration, and single-use status - Creates a VTEXContent-Type (string) required
Accept (string) required
ott (string) required
punchout/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
recommendations_bff/post_api_recommend_bff_v2_events_recommendation_viewRecords when a recommendation shelf enters the viewport. When to send Web storefronts: Automatically captured through Activity Flow when proper data attributes are rendered on the shelf container. See the integration guides for details. Mobile apps: Send this event when the recommendation shelf becomes visible e.g., when at least 50% of the shelf is visible for 1 second. Ensure events are properly debounced to prevent duplicates. Important notes - Always use the same session recommendx-vtex-rec-origin (string) required
an (string) required
data: {
. userId (string)
. correlationId (string)
. products (array)
. campaignId (string)
} (object) required
recommendations_bff/post_api_recommend_bff_v2_events_recommendation_clickRecords when a user clicks on a recommended product. When to send Web storefronts: Automatically captured through Activity Flow when proper data attributes are rendered on each product card. See the integration guides for details. Mobile apps: Send this event when the user taps on a recommended product. Important notes - Always use the same session recommendationsUserId in the userId field for accurate tracking. - Include the correlationId returned in the Fetch recommendationshttps://x-vtex-rec-origin (string) required
an (string) required
data: {
. userId (string)
. product (string)
. correlationId (string)
. campaignId (string)
} (object) required
recommendations_bff/get_api_recommend_bff_v2_recommendationsRetrieves recommended products with full product details based on the provided campaign VRN Virtual Resource Name. The campaign VRN identifies a specific recommendation strategy and follows the format: vrn:recommendations:store-name:campaignType:campaignId You can obtain the full VRN from: - VTEX Supporthttps://help.vtex.com/en/support. - VTEX Admin at Storefront Recommendations click the three dots next to a shelf and select Copy ID. Campaign types and requirements Non-contextual campaix-vtex-rec-origin (string) required
an (string) required
campaignVrn (string) required
userId (string)
products (string)
salesChannel (string)
locale (string)
zipCode (string)
pickupPoint (string)
regionId (string)
recommendations_bff/post_api_recommend_bff_v2_users_start_sessionStarts or updates a user's recommendation session by associating the userId with the current orderFormId and returning the recommendationsUserId to use in subsequent requests. This endpoint: - Sets the vtex-rec-user-id cookie with the returned recommendationsUserId. - Sets the vtex-rec-user-start-session cookie to control when a new session call is needed. - Saves the recommendations identifier in the orderForm custom data for purchase attribution. - Links anonymous browsing behavior to completx-vtex-rec-origin (string) required
x-forwarded-host (string)
host (string)
an (string) required
data: {
. orderFormId (string)
. userId (string)
} (object) required
recommendations_bff/post_api_recommend_bff_v2_events_product_viewRecords when a user views a product detail page. This event is used to measure performance and improve recommendations. When to send Send this event when the user opens a product detail page PDP. Important notes - Always use the same session recommendationsUserId in the userId field for accurate tracking. - When source is not provided, the API attempts to infer it from the user-agent header. - For web integrations, use WEB_DESKTOP or WEB_MOBILE. - For mobile app integrations, use WEB_Mx-vtex-rec-origin (string) required
user-agent (string)
an (string) required
data: {
. userId (string)
. product (string)
. source (string)
. name (string)
. category (string)
. url (string)
} (object) required
recommendations_bff/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
reviews_and_ratings/get_reviews_and_ratings_api_rating_by_product_idRetrieves the rating of a product. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.productId (string)
reviews_and_ratings/get_reviews_and_ratings_api_review_by_review_idRetrieves information of a product review based on the review's ID. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.reviewId (string)
reviews_and_ratings/delete_reviews_and_ratings_api_review_by_review_idDeletes an existing review. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.reviewId (string)
reviews_and_ratings/patch_reviews_and_ratings_api_review_by_review_idUpdates the information of a review. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.reviewId (string)
data: {
. productId (string)
. rating (number)
. title (string)
. text (string)
. reviewerName (string)
. shopperId (string)
. verifiedPurchaser (boolean)
. locale (string)
} (object) required
reviews_and_ratings/get_reviews_and_ratings_api_reviewsRetrieves a list of reviews related to a product. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.search_term (string)
from (string)
to (string)
order_by (string)
status (boolean)
product_id (string)
reviews_and_ratings/post_reviews_and_ratings_api_reviewsCreates multiple reviews for more than one product in a single operation. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3. For authentication, you must generate and use only the API key and the Application Token to work with this endpoint. Refer to the API authentication using application keyshttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys and Generating internal applicatdata (array) required
reviews_and_ratings/delete_reviews_and_ratings_api_reviewsDeletes multiple reviews at once. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.data (array) required
reviews_and_ratings/post_reviews_and_ratings_api_reviewCreates a single review. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3. For authentication, you must generate and use only your VtexidClientAutCookie to work with this endpoint. Refer to the Generating user tokenshttps://developers.vtex.com/docs/guides/api-authentication-using-user-tokens generating-a-user-token-with-the-vtex-io-cli guide for more information.data: {
. productId (string)
. rating (integer)
. title (string)
. text (string)
. reviewerName (string)
. approved (boolean)
} (object) required
reviews_and_ratings/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
sku_bindings/get_sku_binding_pvt_skusellers_by_sku_idRetrieves SKU bindings details searching by SKU ID. ❗ The path /api/catalog/pvt/skusellers/skuId is deprecated. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicabskuId (string)
Content-Type (string) required
Accept (string) required
sku_bindings/get_sku_binding_pvt_skuseller_adminRetrieves SKU bindings administrative information using optional query params sellerId, skuId, sellerSkuId and IsActive to filter results and size to restrict the amount of results. ℹ This path is an updated version of /api/catalog_system/pvt/skuseller/admin. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resosellerId (string)
skuId (string)
sellerSkuId (string)
isActive (boolean)
size (string)
Content-Type (string) required
Accept (string) required
sku_bindings/get_sku_binding_pvt_skuseller_by_seller_id_by_seller_sku_idRetrieves a seller SKU details, given a seller ID and the SKU ID in the seller's store. ℹ This path is an updated version of /api/catalog_system/pvt/skuseller/sellerId/sellerSkuId. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. OthesellerId (string)
sellerSkuId (string)
Content-Type (string) required
Accept (string) required
sku_bindings/put_sku_binding_pvt_skuseller_by_seller_id_by_seller_sku_idAssociates a seller's SKU to another marketplace SKU. ℹ This path is an updated version of /api/catalog_system/pvt/skuseller/sellerId/sellerSkuId. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status csellerId (string)
sellerSkuId (string)
Content-Type (string) required
Accept (string) required
data: {
. StockKeepingUnitId (integer)
} (object) required
sku_bindings/get_sku_binding_pvt_skuseller_list_byseller_id_by_seller_idRetrieves a list of SKU bindings given a specific seller ID. ℹ This path is an updated version of /api/catalog_system/pvt/skuseller/list/bysellerId/sellerId. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receivesellerId (string)
Content-Type (string) required
Accept (string) required
sku_bindings/get_sku_binding_pvt_skuseller_paged_sellerid_by_seller_idRetrieves a paged list of SKU bindings given a specific seller ID. ℹ This path is an updated version of /api/catalog_system/pvt/skuseller/paged/sellerid/sellerId. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will resellerId (string)
page (string) required
size (string) required
Content-Type (string) required
Accept (string) required
sku_bindings/post_sku_binding_pvt_skuseller_changenotification_by_sku_idSends a seller notification to the VTEX marketplace about a SKU suggestion using the SKU ID. It can be either a new suggestion or an update to an existing one. For example, a seller SKU previously approved by the marketplace may have had price or inventory changes. This request does not require a request body. ℹ This path is an updated version of /api/catalog_system/pvt/skuseller/changenotification/skuId. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/apiskuId (string)
Content-Type (string) required
Accept (string) required
sku_bindings/post_sku_binding_pvt_skuseller_changenotification_by_seller_id_by_seller_sku_idSends a seller notification to the VTEX marketplace about a SKU suggestion, which can be either a new suggestion or an update. For example, a seller SKU previously approved by the marketplace may have had price or inventory changes. The main information sent by the seller is its identification sellerId and the SKU binding code sellerSkuId, both passed as path parameters. This request doesn't require a request body. ℹ This path is an updated version of /api/catalog_system/pvt/skuseller/chsellerId (string)
sellerSkuId (string)
Content-Type (string) required
Accept (string) required
sku_bindings/post_sku_binding_pvt_skuseller_insertionCreates an SKU binding, associating a seller's SKU with a marketplace's SKU. ℹ This path is an updated version of /api/catalog_system/pvt/skuseller/insertion. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receivContent-Type (string) required
Accept (string) required
data: {
. StockKeepingUnitId (integer)
. IsActive (boolean)
. SellerId (string)
. SellerStockKeepingUnitId (string)
} (object) required
sku_bindings/post_sku_binding_pvt_skuseller_activate_by_seller_id_by_sku_seller_idChanges the status of an SKU binding to active, setting isActive to true. ℹ This path is an updated version of /api/catalog_system/pvt/skuseller/activate/sellerId/skuSellerId. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. OtherwisesellerId (string)
skuSellerId (string)
Content-Type (string) required
Accept (string) required
sku_bindings/post_sku_binding_pvt_skuseller_inactivate_by_seller_id_by_sku_seller_idChanges the status of an SKU binding to inactive, setting isActive to false. ℹ This path is an updated version of /api/catalog_system/pvt/skuseller/inactivate/sellerId/skuSellerId. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. OthesellerId (string)
skuSellerId (string)
Content-Type (string) required
Accept (string) required
sku_bindings/post_sku_binding_pvt_skuseller_remove_by_seller_id_by_seller_sku_idRemoves a seller's SKU binding, given the seller ID and the SKU ID in the seller's store. ℹ This path is an updated version of /api/catalog_system/pvt/skuseller/remove/sellerId/sellerSkuId. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this requsellerId (string)
sellerSkuId (string)
Content-Type (string) required
Accept (string) required
sku_bindings/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
ssl_certificates/get_api_edge_certificatesRetrieves a list of SSL certificates. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -----Content-Type (string) required
Accept (string) required
ssl_certificates/put_api_edge_certificatesInstalls or renews an SSL certificate using application/json or multipart/form-data content types. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, they will receive a status code 403 error. These are the applicable resources forContent-Type (string) required
Accept (string) required
data: {
. hosts (array)
. certificate (string)
. privateKey (string)
} (object) required
ssl_certificates/get_api_edge_certificates_by_certificate_idRetrieves information about a specific SSL certificate. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise, they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | RcertificateId (string)
Content-Type (string) required
Accept (string) required
ssl_certificates/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
search/get_api_catalog_system_pub_products_crossselling_whosawalsosaw_by_product_id❗ This endpoint is deprecated and may not work as expected. Instead, it returns a list of products from the same category.productId (integer)
search/get_api_catalog_system_pub_products_crossselling_whosawalsobought_by_product_id❗ This endpoint is deprecated and may not work as expected. Instead, it returns a list of products from the same category.productId (string)
search/get_api_catalog_system_pub_products_crossselling_whoboughtalsobought_by_product_id❗ This endpoint is deprecated and may not work as expected. Instead, it returns a list of products from the same category.productId (string)
search/get_api_catalog_system_pub_products_crossselling_showtogether_by_product_idRetrieves general information about the products that are show together with the product in question.productId (integer)
search/get_api_catalog_system_pub_products_crossselling_accessories_by_product_idRetrieves general information about the product's accessories.productId (integer)
search/get_api_catalog_system_pub_products_crossselling_similars_by_product_idRetrieves general information about related product searches.productId (integer)
search/get_api_catalog_system_pub_products_crossselling_suggestions_by_product_idRetrieves general information about other product suggestions related to the product.productId (integer)
search/get_api_catalog_system_pub_products_search_by_searchRetrieves general information about the products related to the term searched. This is the main search used by the store. The user can type anything to be searched. For example, if they search for a 'decanter', this is the URL: https://accountName.environment.com.br/api/catalog_system/pub/products/search/decanter. Note that maybe the response can be HTTP 200 or 206, 206 means that it's a partial content response. If it is a 206 take a look at the Headers, will be an entry called research (string)
search/get_api_catalog_system_pub_products_searchRetrieves general information about the store's products. This information can be filtered and ordered by a number of options. It also can be paginated, filtered and ordered. Filters - Filter by full text - ft=searchWord E.g.: ft=television - Filter by category - fq=C:/a/b a and b are Category IDs E.g.: fq=C:/1000041/1000049/ - Filter by brand - fq=B:/a/b a and b are Brand IDs E.g.: fq=B:/189385/189387/ - Filter by specification - fq=specificationFilter_a:b_from (string)
_to (string)
ft (string)
fq (string)
O (string)
search/get_api_catalog_system_pub_products_search_by_product_text_link_pRetrieves general information about the product of the URL you searched for.product-text-link (string)
search/get_api_catalog_system_pub_products_offers_by_product_idRetrieves existing offers of a specific product.productId (string)
search/get_api_catalog_system_pub_products_offers_by_product_id_sku_by_sku_idRetrieves existing offers of a specific SKU.productId (string)
skuId (string)
search/get_api_catalog_system_pub_facets_category_by_category_idRetrieves the names and IDs of the categories facets. ⚠️ This endpoint returns a maximum of 50 items per response, so the difference between _from and _to should not exceed this number. The result order is descending, from the highest product ID to the lowest. Response body example: json 'Name':'Tamanho Global', 'Id':45 , 'Name':'Percentuals', 'Id':25categoryId (string)
_from (string)
_to (string)
search/get_api_catalog_system_pub_facets_search_by_termRetrieves products by store facets. The result order is descending, from the highest product ID to the lowest.term (string)
map (string) required
search/get_buscaautocompleteRetrieves product's information related to the searched string. searchString is the part of string the user is looking for. E.g.: ref | refrig | refrigeratorproductNameContains (string) required
search/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
session_manager/post_api_sessionsCreates a new session and returns a session token and a segment token. Also stores vtex_session and vtex_segment cookies, with the same values returned in the response. All parameters in the body that are not within the public namespace will be ignored. Query string items will automatically be added to the public namespace. ⚠️ The Session Manager API uses the vtex_session and vtex_segment cookies to store the data required to identify the user and the session. These cookies are stored in tdata: {
. public (object)
} (object) required
session_manager/get_api_sessionsRetrieves information from a previously created sesssion. ⚠️ The Session Manager API uses the vtex_session and vtex_segment cookies to store the data required to identify the user and the session. These cookies are stored in the user's browser when the session is created and sent automatically in every request to that domain. You will have to reproduce that by sending these cookies as headers to Session Manager API in order for it to work outside of a browser environment. Permissionsitems (string) required
session_manager/patch_api_sessionsEdits information from a previously created sesssion. This endpoint works the same way as the Create new sessionhttps://developers.vtex.com/docs/api-reference/session-manager-api post-/api/sessions endpoint, but when the request is sent with a vtex_session and the vtex_segment cookies in the header, it retrieves the session first and then applies the changes instead of generating a new one. Only keys inside the public namespace in the request body are considered, and query parameters are adata: {
. public (object)
} (object) required
session_manager/get_api_segmentsRetrieves information about the segment, which contains additional data related to the session's context. You can add certain public fields as the query string and the system will attempt to fulfill it. Values such as cultureInfo and utm are overwriteable, just keep in mind such changes will not be reflected in the client's session. If you wish to change the value on the session and thus be reflected on the segment without special query strings, then use the Edit sessionhttps://developers.No parameters
session_manager/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
shopee_integration/get_api_shopeeintegration_order_shipping_labelReturns shipping label data for a Shopee order as JSON. On success the label file is included Base64-encoded typically a ZIP archive. The credential must be valid for the account indicated by query parameter an. Authentication This endpoint requires a valid user tokenhttps://developers.vtex.com/docs/guides/api-authentication-using-user-tokens in the VtexIdclientAutCookie header for example from Admin VTEX login. API keyshttps://developers.vtex.com/docs/guides/api-authentication-using-apAccept (string) required
an (string) required
shopeeOrderId (string) required
shopee_integration/post_api_shopeeintegration_by_account_name_pub_orders_by_mktplace_order_id_cancel_deliveryCancels delivery for a marketplace order received through VTEX callback. Authentication This endpoint requires the store admin user tokenhttps://developers.vtex.com/docs/guides/api-authentication-using-user-tokens in the VtexIdclientAutCookie header session from Admin VTEX login. API keys X-VTEX-API-AppKey / X-VTEX-API-AppToken are not used for this operation. Permissions The authenticated store user must have at least one of the appropriate License Manager resourceshttps://helaccountName (string)
mktplaceOrderId (string)
Accept (string) required
shopee_integration/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
storefront_roles/post_api_license_manager_storefront_roles_assignAssigns a specific storefront role to an existing user. ⚠️ This feature is available only for stores using B2B Buyer Portalhttps://help.vtex.com/docs/tutorials/b2b-buyer-portal, currently available for select accounts. ℹ️ Learn more about the available storefront roles and resources at the Storefront Roleshttps://developers.vtex.com/docs/guides/storefront-roles guide. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must haveContent-Type (string) required
Accept (string) required
data: {
. roleId (integer)
. userId (string)
} (object) required
storefront_roles/delete_api_license_manager_storefront_user_rolesRemoves the specified storefront roles from a user. The endpoint ignores role IDs that do not exist or are not assigned to the user. Returns the resulting role list after removal. ⚠️ This feature is available only for stores using B2B Buyer Portalhttps://help.vtex.com/docs/tutorials/b2b-buyer-portal, currently available for select accounts. ℹ️ Learn more about the available storefront roles and resources at the Storefront Roleshttps://developers.vtex.com/docs/guides/storefront-roles guideContent-Type (string) required
Accept (string) required
data: {
. id (string)
. roleIds (array)
} (object) required
storefront_roles/post_api_license_manager_storefront_user_rolesFully updates the user's role list based on the roleIds provided. This endpoint replaces all existing roles with the specified ones. If the user does not exist, this endpoint creates the user and assigns the indicated roles. ⚠️ This feature is available only for stores using B2B Buyer Portalhttps://help.vtex.com/docs/tutorials/b2b-buyer-portal, currently available for select accounts. ℹ️ Learn more about the available storefront roles and resources at the Storefront Roleshttps://developerContent-Type (string) required
Accept (string) required
data: {
. id (string)
. roleIds (array)
} (object) required
storefront_roles/get_api_license_manager_storefront_users_by_user_id_resources_by_resource_key_grantedVerifies if a specific storefront user has access to a particular storefront resource. ⚠️ This feature is available only for stores using B2B Buyer Portalhttps://help.vtex.com/docs/tutorials/b2b-buyer-portal, currently available for select accounts. ℹ️ Learn more about the available storefront roles and resources at the Storefront Roleshttps://developers.vtex.com/docs/guides/storefront-roles guide. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authenticatuserId (string)
resourceKey (string)
Content-Type (string) required
Accept (string) required
storefront_roles/delete_api_license_manager_storefront_remove_users_by_user_idRemoves a storefront user from the system, including all their storefront role assignments. ⚠️ This feature is available only for stores using B2B Buyer Portalhttps://help.vtex.com/docs/tutorials/b2b-buyer-portal, currently available for select accounts. ℹ️ Learn more about the available storefront roles and resources at the Storefront Roleshttps://developers.vtex.com/docs/guides/storefront-roles guide. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authenuserId (string)
Content-Type (string) required
Accept (string) required
storefront_roles/get_api_license_manager_storefront_users_by_user_id_rolesRetrieves all storefront roles assigned to a specific user by user ID. ⚠️ This feature is available only for stores using B2B Buyer Portalhttps://help.vtex.com/docs/tutorials/b2b-buyer-portal, currently available for select accounts. ℹ️ Learn more about the available storefront roles and resources at the Storefront Roleshttps://developers.vtex.com/docs/guides/storefront-roles guide. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview apiuserId (string)
Accept (string) required
storefront_roles/get_api_license_manager_storefront_users_by_email_rolesRetrieves all storefront roles assigned to a specific user by email. ⚠️ This feature is available only for stores using B2B Buyer Portalhttps://help.vtex.com/docs/tutorials/b2b-buyer-portal, currently available for select accounts. ℹ️ Learn more about the available storefront roles and resources at the Storefront Roleshttps://developers.vtex.com/docs/guides/storefront-roles guide. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-kemail (string)
Content-Type (string) required
Accept (string) required
storefront_roles/get_api_license_manager_storefront_users_by_user_idRetrieves storefront user details by ID. ⚠️ This feature is available only for stores using B2B Buyer Portalhttps://help.vtex.com/docs/tutorials/b2b-buyer-portal, currently available for select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully ruserId (string)
Content-Type (string) required
Accept (string) required
storefront_roles/get_api_license_manager_storefront_roleReturns all storefront roles visible to the account, including native VTEX roles and the account's own custom roles. An empty array is a valid response. ⚠️ This feature is available only for stores using B2B Buyer Portalhttps://help.vtex.com/docs/tutorials/b2b-buyer-portal, currently available for select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourcesan (string) required
Accept (string) required
storefront_roles/post_api_license_manager_storefront_roleCreates a new account-scoped custom role with the specified name and resource assignments. ⚠️ This feature is available only for stores using B2B Buyer Portalhttps://help.vtex.com/docs/tutorials/b2b-buyer-portal, currently available for select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3an (string) required
Content-Type (string) required
Accept (string) required
data: {
. Name (string)
. Resources (array)
} (object) required
storefront_roles/get_api_license_manager_storefront_role_by_role_idRetrieves a single role by its identifier. ⚠️ This feature is available only for stores using B2B Buyer Portalhttps://help.vtex.com/docs/tutorials/b2b-buyer-portal, currently available for select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfullyroleId (integer)
an (string) required
Accept (string) required
storefront_roles/put_api_license_manager_storefront_role_by_role_idReplaces the full resource list of an existing custom role. Send all resources you want the role to have after the update. ⚠️ This feature is available only for stores using B2B Buyer Portalhttps://help.vtex.com/docs/tutorials/b2b-buyer-portal, currently available for select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorroleId (integer)
an (string) required
Content-Type (string) required
Accept (string) required
data: {
. Resources (array)
} (object) required
storefront_roles/delete_api_license_manager_storefront_role_by_role_idPermanently removes a custom role from the account. The role must be unassigned from all users before it can be deleted. Native VTEX roles cannot be deleted. ⚠️ This feature is available only for stores using B2B Buyer Portalhttps://help.vtex.com/docs/tutorials/b2b-buyer-portal, currently available for select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resoroleId (integer)
an (string) required
Accept (string) required
storefront_roles/get_api_license_manager_storefront_resourceReturns every storefront resource visible to the account, including native VTEX resources and the account's own custom resources. ⚠️ This feature is available only for stores using B2B Buyer Portalhttps://help.vtex.com/docs/tutorials/b2b-buyer-portal, currently available for select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/ean (string) required
Accept (string) required
storefront_roles/post_api_license_manager_storefront_resourceRegisters a new account-scoped permission resource. Each account may hold at most 10 custom resources. ⚠️ This feature is available only for stores using B2B Buyer Portalhttps://help.vtex.com/docs/tutorials/b2b-buyer-portal, currently available for select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-an (string) required
Content-Type (string) required
Accept (string) required
data: {
. Key (string)
. Name (string)
. Description (string)
} (object) required
storefront_roles/delete_api_license_manager_storefront_resource_by_idRemoves a account-level custom resource. Native VTEX resources cannot be deleted through this endpoint. ⚠️ This feature is available only for stores using B2B Buyer Portalhttps://help.vtex.com/docs/tutorials/b2b-buyer-portal, currently available for select accounts. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-managerid (integer)
an (string) required
Accept (string) required
storefront_roles/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
subscriptions_api_v3/get_api_rns_pub_cycles_by_cycle_idRetrieves a specific cycle by its ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | -----cycleId (string)
subscriptions_api_v3/get_api_rns_pub_cyclesLists subscription cycles, based on filters defined in the query parameters. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | PbeginDate (string)
endDate (string)
subscriptionId (string)
customerEmail (string)
status (string)
page (integer)
size (integer)
subscriptions_api_v3/post_api_rns_pub_cycles_by_cycle_id_retryEvery subscription order has an execution count called cycle, which determines the position of an order counting from when the shopper subscribed. This endpoint reruns a cycle that is currently in error state. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfullcycleId (string)
subscriptions_api_v3/get_api_rns_pvt_plansLists subscription plans, based on filters defined in the query parameters. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Prperiodicity (string)
interval (string)
page (integer)
size (integer)
subscriptions_api_v3/get_api_rns_pvt_plans_by_idRetrieves a specific subscription plan by its ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resourcid (string)
subscriptions_api_v3/get_api_rns_pvt_reportsLists all subscription report templates available. ℹ️ After choosing the desired template, use the Generate reporthttps://developers.vtex.com/docs/api-reference/subscriptions-api-v3 post-/api/rns/pvt/reports/-reportName-/documents endpoint to create the report for your store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/licenNo parameters
subscriptions_api_v3/get_api_rns_pvt_reports_by_report_name_documents_by_document_idRetrieves information about a subscription report document, searching by document ID. In the status code 200 OK response, you get a link to download the report. ❗ Before using this endpoint, you must create a report with the Generate reporthttps://developers.vtex.com/docs/api-reference/subscriptions-api-v3 post-/api/rns/pvt/reports/-reportName-/documents endpoint and get the document ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-areportName (string)
documentId (string)
subscriptions_api_v3/post_api_rns_pvt_reports_by_report_name_documentsCreates a subscriptions report in the format of a csv file and sends it via email to a given user. ℹ️ In the response body of the current endpoint, you get the document ID required for the Get report document detailshttps://developers.vtex.com/docs/api-reference/subscriptions-api-v3 get-/api/rns/pvt/reports/-reportName-/documents/-documentId- endpoint. You can generate the following types of report: - subscriptionsWithStatus: Get subscriptions based on subscription cycle execution statureportName (string)
email (string)
status (string)
beginDate (string)
endDate (string)
subscriptions_api_v3/get_api_rns_pub_subscriptions_by_idRetrieves information about a subscription, searching by subscription ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Prodid (string)
subscriptions_api_v3/patch_api_rns_pub_subscriptions_by_idUpdates a subscription, searching by subscription ID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resid (string)
data: {
. customerEmail (string)
. title (string)
. status (string)
. nextPurchaseDate (string)
. isSkipped (boolean)
. plan (object)
. shippingAddress (object)
. purchaseSettings (object)
} (object) required
subscriptions_api_v3/get_api_rns_pub_subscriptionsLists subscriptions from your store. By default, this request uses the query parameter page = 1, and size = 15. If you wish, you can use different values for query parameters. ⚠️ Each response is limited to 15 results. You can get different values by combining pagination query parameters. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/customerEmail (string)
status (string)
addressId (string)
paymentId (string)
planId (string)
nextPurchaseDate (string)
originalOrderId (string)
page (integer)
size (integer)
subscriptions_api_v3/post_api_rns_pub_subscriptionsCreates a new subscription. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | ---------------data: {
. customerEmail (string)
. title (string)
. status (string)
. nextPurchaseDate (string)
. catalogAttachment (string)
. plan
. shippingAddress
. purchaseSettings
. items (array)
} (object) required
subscriptions_api_v3/delete_api_rns_pub_subscriptions_by_id_items_by_item_idRemoves an item from a given subscription. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | |id (string)
itemId (string)
subscriptions_api_v3/patch_api_rns_pub_subscriptions_by_id_items_by_item_idEdits an item from a given subscription. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --id (string)
itemId (string)
data: {
. status (string)
. isSkipped (boolean)
. quantity (integer)
. manualPrice (number)
} (object) required
subscriptions_api_v3/post_api_rns_pub_subscriptions_by_id_itemsAdds a new item to a given subscription. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --id (string)
data: {
. skuId (string)
. quantity (integer)
. manualPrice (number)
} (object) required
subscriptions_api_v3/post_api_rns_pub_subscriptions_by_id_simulateSimulates an order made by the specific subscription on checkout and retrieves the current price for items and shipping. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the apid (string)
subscriptions_api_v3/post_api_rns_pub_subscriptions_simulateSimulates an order made by subscriptions on checkout and retrieves the current price for items and shipping. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resdata: {
. customerEmail (string)
. title (string)
. status (string)
. nextPurchaseDate (string)
. catalogAttachment (string)
. plan
. shippingAddress
. purchaseSettings
. items (array)
} (object) required
subscriptions_api_v3/get_api_rns_pub_subscriptions_by_subscription_id_conversation_messageRetrieves all conversation messages sent to a customer regarding a subscription. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:subscriptionId (string)
subscriptions_api_v3/get_api_rns_settingsRetrieves information about the subscriptions settings of your store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | ProductNo parameters
subscriptions_api_v3/post_api_rns_settingsEdits the subscriptions settings of your store. This configurations apply to all subscriptions. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for thdata: {
. slaOption (string)
. defaultSla (string)
. isUsingV3 (boolean)
. onMigrationProcess (boolean)
. executionHourInUtc (integer)
. workflowVersion (string)
. deliveryChannels (array)
. randomIdGeneration (boolean)
. isMultipleInstallmentsEnabledOnCreation (boolean)
. isMultipleInstallmentsEnabledOnUpdate (boolean)
. attachmentPreferences (object)
. orderCustomDataAppId (string)
. postponeExpiration (boolean)
. manualPriceAllowed (boolean)
. useItemPriceFromOriginalOrder (boolean)
} (object) required
subscriptions_api_v3/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
tracking/post_authThis endpoint permits the user to acquire the mandatory authentication to access the VTEX Trackinghttps://help.vtex.com/en/tutorial/vtex-tracking-overview--1uDRquVudbPuoK05MtbZGh endpoints. There is a single version of VTEX Tracking API, so it is no longer necessary to specify the version on the URL, as explained in this release notehttps://developers.vtex.com/updates/release-notes/vtex-tracking-api-changes-in-all-paths. The previous routes were not deprecated and can still be used, and if thContent-Type (string) required
Accept (string) required
data: {
. username (string)
. password (string)
} (object) required
tracking/put_servicesRemoves Packing List on your VTEX Tracking configuration. Your request body must contain the invoice and serie fields. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
data (array) required
tracking/post_servicesCreates a delivery service in your Tracking system. It allows the user to configure the Route Scheduling services, without defining the Delivery Person or Route Date. Request body example json 'deliveryServiceType': 'Entrega', 'shipperCustomer': 'legalType': 'PJ', 'companyName': 'COMP. BRAS. DE TECN. PARA E-COMMERCE', 'cnpj': '05314972000174', 'addressStreet': 'Rua Praia de Botafogo', 'addressNContent-Type (string) required
Accept (string) required
data (array) required
tracking/get_servicesRetrieves a list of services with pagination and URLs. You can consult the list using the following filters: the service's registration date, status, page size, and desired number of pages. Check the parameters documented below to see each filter's description. We strongly recommend that a call to a VTEX Tracking GET endpoint is made only once every 6 hours. Retrieving data from the same endpoint more than once during a 6-hour window represents a load to our API that will slow down the overallContent-Type (string) required
Accept (string) required
status (string)
dateInit (string)
dateEnd (string)
pageSize (integer)
page (integer)
tracking/get_services_by_id_delivery_serviceRetrieves a specific Service's general information by searching through its ID. We strongly recommend that a call to a VTEX Tracking GET endpoint is made only once every 6 hours. Retrieving data from the same endpoint more than once during a 6-hour window represents a load to our API that will slow down the overall usage of systems. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.idDeliveryService (integer)
Content-Type (string) required
Accept (string) required
tracking/post_services_routesThis endpoint creates a delivery service in your Tracking system. It allows the user to configure the Route Scheduling services with the Delivery Person and Route date already defined. Request body example json 'deliveryServiceRoute': 'deliveryServiceDate': '2020-09-28', 'displacementType': 'Caminhão', 'carrier': 'username': 'empresa-joao.silva' , 'vehicle': 'registrationPlate': 'XPT-0123' , 'addressStart': 'addressStreet': 'AveniContent-Type (string) required
Accept (string) required
data: {
. deliveryService (array)
. deliveryServiceRoute (object)
} (object) required
tracking/get_services_routesThis endpoint retrieves a list of Delivery Services by Route Item Date Async. We strongly recommend that a call to a VTEX Tracking GET endpoint is made only once every 6 hours. Retrieving data from the same endpoint more than once during a 6-hour window represents a load to our API that will slow down the overall usage of systems. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
status (string)
dateInit (string)
dateEnd (string)
pageSize (integer)
page (integer)
tracking/get_services_invoiceThis endpoint retrieves a given Service's information by filtering through the chosen invoice number. We strongly recommend that a call to a VTEX Tracking GET endpoint is made only once every 6 hours. Retrieving data from the same endpoint more than once during a 6-hour window represents a load to our API that will slow down the overall usage of systems. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6Content-Type (string) required
Accept (string) required
invoice (string)
tracking/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
user_rights/post_api_user_rights_forget_jobs⚠️ This endpoint is in closed beta and currently available for selected accounts only. Creates a job to delete a user's personal data across VTEX applications 'Right to be Forgotten'. The request receives the user's email and returns a job ID that can be used to track the deletion progress via the Get data erasure job statushttps://developers.vtex.com/docs/api-reference/user-rights-api get-/api/user-rights/forget/jobs/-jobId- endpoint. ⚠️ This data erasure flow applies only to non-corporContent-Type (string) required
Accept (string) required
data: {
. email (string)
} (object) required
user_rights/get_api_user_rights_forget_jobs_by_job_id⚠️ This endpoint is in closed beta and currently available for selected accounts only. Retrieves the current status of a data erasure job created via the Create data erasure jobhttps://developers.vtex.com/docs/api-reference/user-rights-api post-/api/user-rights/forget/jobs endpoint. Possible status values: - InProgress: The deletion is still being processed. Keep polling. - Success: The user's data has been deleted. - Failed: The deletion could not be completed. See the message fieldjobId (string)
Accept (string) required
user_rights/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
vtex_do/post_notesCreates a new note in VTEX DOhttps://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu. Be aware of the following limitations: - The maximum number of notes for an order is 30. - The maximum number of characters in a note's description is 2000. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
data: {
. target (object)
. domain (string)
. description (string)
. createdBy (object)
} (object) required
vtex_do/get_notesRetrieves notes related to a specific order ID. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.target.id (string) required
perPage (integer)
page (integer)
reason (string)
Content-Type (string) required
Accept (string) required
vtex_do/get_notes_by_note_idRetrieves a given note in VTEX DOhttps://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu, filtering by note ID. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.noteId (string)
Content-Type (string) required
Accept (string) required
reason (string)
vtex_do/post_tasksCreates a new task in VTEX DOhttps://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
data: {
. target (array)
. domain (string)
. context (string)
. name (string)
. priority (string)
. surrogateKey (string)
. description (string)
. dueDate (string)
. assignee (object)
. followers (array)
. parentTaskId (string)
} (object) required
vtex_do/get_tasksThis endpoint allows you to filter VTEX DOhttps://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu tasks. You can choose between the following filtering options: - Assignees: using assignee.email and status. Example: https://accountName.environment.com.br/api/do/tasks?assignee.email=person@email.com and status=open. - Targets: using targetId and status. Example: https://accountName.environment.com.br/api/do/tasks?target.id=name and status=open. - Paged tasks: using page, perPassignee.email (string)
target.id (string)
context (string)
page (string)
perPage (string)
status (string)
Content-Type (string) required
Accept (string) required
vtex_do/get_tasks_by_task_idRetrieves a given VTEX DOhttps://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu task, filtering by task ID. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.taskId (string)
Content-Type (string) required
Accept (string) required
vtex_do/put_tasks_by_task_idUpdates the status of a VTEX DOhttps://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu task, filtering by task ID. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.taskId (string)
Content-Type (string) required
Accept (string) required
data: {
. status (string)
} (object) required
vtex_do/post_tasks_by_task_id_commentsAdds a comment to a VTEX DOhttps://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu task, filtering by task ID. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.taskId (string)
Content-Type (string) required
Accept (string) required
data: {
. text (string)
} (object) required
vtex_do/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
vtex_id/post_api_authenticator_storefront_usersCreates a new storefront user in VTEX ID with one or more authentication identifiers username, email, or phone number. The created user is not linked to any Organization Unit and does not have storefront permissions. For more information on how to provision B2B users, see the B2B user provisioning guidehttps://developers.vtex.com/docs/guides/b2b-user-provisioning. ⚠️ This feature is only available for stores using B2B Buyer Portalhttps://help.vtex.com/docs/tutorials/b2b-buyer-portal, whichContent-Type (string) required
Accept (string) required
isLegacyPassword (boolean)
data: {
. identifiers (array)
} (object) required
vtex_id/servers_api_authenticator_v1_tenants_features_by_nameNo description availablename (string)
vtex_id/put_api_authenticator_v1_tenants_features_by_nameConfigures or updates the external authentication middleware settings for B2B password migration. This endpoint registers the middleware URL and HMAC credentials that VTEX will use to validate legacy user credentials during their first login. Once configured, users with the isLegacyPassword flag set to true will have their credentials validated against the configured middleware endpoint on their first login attempt. For more information, see the B2B password migration guidehttps://developename (string)
Content-Type (string) required
Accept (string) required
data: {
. clientId (string)
. idpEndpoint (string)
. secret (string)
} (object) required
vtex_id/patch_api_authenticator_v1_tenants_features_by_nameEnables or disables the B2B password migration feature for your account without removing the configuration. When disabled, legacy password validation will not be performed, even for users with isLegacyPassword=true. For more information, see the B2B password migration guidehttps://developers.vtex.com/docs/guides/b2b-password-migration. ⚠️ This feature is only available for stores using B2B Buyer Portalhttps://help.vtex.com/docs/tutorials/b2b-buyer-portal, which is currently available to sname (string)
Content-Type (string) required
Accept (string) required
data: {
. enabled (boolean)
} (object) required
vtex_id/delete_api_authenticator_v1_tenants_features_by_nameRemoves the B2B password migration configuration from your account entirely, including all middleware endpoint settings and HMAC credentials. After deletion, legacy password validation will no longer be available. For more information, see the B2B password migration guidehttps://developers.vtex.com/docs/guides/b2b-password-migration. ⚠️ This feature is only available for stores using B2B Buyer Portalhttps://help.vtex.com/docs/tutorials/b2b-buyer-portal, which is currently available to selname (string)
Accept (string) required
vtex_id/get_api_vtexid_pvt_user_infoFetches a storefront user by their identifier username or email. The identifier must be provided as a URL-encoded query parameter. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These auser (string) required
Content-Type (string) required
Accept (string) required
vtex_id/servers_api_vtexid_apptoken_loginNo description availableNo parameters
vtex_id/post_api_vtexid_apptoken_loginGenerate a tokenhttps://developers.vtex.com/vtex-rest-api/docs/getting-started-authentication user-token from a given app key and app tokenhttps://help.vtex.com/en/tutorial/api-keys--2iffYzlvvz4BDMr6WGUtet pair. You can use this token to authenticate requests to VTEX APIs by sending it as a header named VtexIdclientAutCookie. The token's permissions are the same as defined to the credential pairhttps://help.vtex.com/en/tutorial/api-keys--2iffYzlvvz4BDMr6WGUtet managing-app-key-permissions. SContent-Type (string) required
Accept (string) required
an (string)
data: {
. appkey (string)
. apptoken (string)
} (object) required
vtex_id/servers_api_vtexid_audience_webstore_provider_oauth_exchangeNo description availableNo parameters
vtex_id/post_api_vtexid_audience_webstore_provider_oauth_exchangeIf your store uses a headless frontend, you can authenticate users via OAuth and use this endpoint to exchange the OAuth access token for a VTEX authentication token. This VTEX token can be used to authenticate your frontend requests to VTEX APIs. Learn more about how to implement headless authenticationhttps://developers.vtex.com/docs/guides/headless-authentication in your store. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-accountName (string)
environment (string)
Content-Type (string) required
Accept (string) required
data: {
. providerId (string)
. accessToken (string)
. duration (integer)
} (object) required
vtex_id/servers_api_vtexid_credential_validateNo description availableNo parameters
vtex_id/post_api_vtexid_credential_validateRetrieves information about the user who is currently authenticated in your store, given an user token. If the user is not authenticated, the response for this API will be 401 Unauthorized. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.environment (string)
Content-Type (string) required
Accept (string) required
an (string)
data: {
. token (string)
} (object) required
vtex_id/servers_api_vtexid_pub_providers_setup_password_webstore_passwordNo description availableNo parameters
vtex_id/post_api_vtexid_pub_providers_setup_password_webstore_passwordDefines if user passwords can be repeated in your store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category |accountName (string)
Content-Type (string) required
Accept (string) required
data: {
. isActive (boolean)
. allowRepeated (boolean)
} (object) required
vtex_id/servers_api_vtexid_password_expireNo description availableNo parameters
vtex_id/post_api_vtexid_password_expireExpires an user's password in your store. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint: | Product | Category | Resource | | --accountName (string)
environment (string)
Content-Type (string) required
Accept (string) required
email (string) required
vtex_id/servers_api_vtexid_apikey_by_api_key_apitoken_renewNo description availableapiKey (string)
vtex_id/patch_api_vtexid_apikey_by_api_key_apitoken_renewStarts the API token renewal process by generating a new token while keeping the current token active. This ensures a smooth transition without service disruption. The previous token and the new token are both valid until the renewal process is completed by making a request to PATCH Complete token renewalhttps://developers.vtex.com/docs/api-reference/vtex-id-api patch-/api/vtexid/apikey/-apiKey-/apitoken/finish-renewal. Permissions Any user or API keyhttps://developers.vtex.com/docs/apiKey (string)
vtex_id/servers_api_vtexid_apikey_by_api_key_apitoken_finish_renewalNo description availableapiKey (string)
vtex_id/patch_api_vtexid_apikey_by_api_key_apitoken_finish_renewalFinalizes the API token renewal process, deactivating the old token. After this step, the old token can no longer be used, ensuring security by enforcing a controlled rotation. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/authentication-overview api-keys must have at least one of the appropriate License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3 to be able to successfully run this request. Otherwise theyapiKey (string)
vtex_id/get_api_vtexid_pvt_user_idRetrieves the unique user ID for a given email address. Permissions This endpoint does not require License Manager resourceshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3. However, it does require a valid user token VtexIdclientAutCookie to be included in the request headers. To learn more about user authentication at VTEX, see Authentication overviewhttps://developers.vtex.com/docs/guides/authentication-overview user-authentication.usuario (string) required
Content-Type (string) required
Accept (string) required
vtex_id/servers_api_vtexid_pub_authentication_startNo description availableNo parameters
vtex_id/get_api_vtexid_pub_authentication_startStarts the authentication flow for a user in your store. This endpoint returns an authentication token valid for 24 hours. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
scope (string) required
fingerprint (string)
vtex_id/servers_api_vtexid_pub_authentication_accesskey_sendNo description availableNo parameters
vtex_id/post_api_vtexid_pub_authentication_accesskey_sendSends an access key to the user's email address, if the response is empty with 200 OK. The access key is used to authenticate the user in your store. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
email (string) required
vtex_id/servers_api_vtexid_pub_authentication_accesskey_validateNo description availableNo parameters
vtex_id/post_api_vtexid_pub_authentication_accesskey_validateValidates the user session using the access key sent to the user through the Send access keyhttps://developers.vtex.com/docs/api-reference/vtex-id-api post-/api/vtexid/pub/authentication/accesskey/send endpoint. The refresh token vid_rt is returned in the Set-Cookie header. This token is required for the Refresh tokenhttps://developers.vtex.com/docs/api-reference/vtex-id-api post-/api/vtexid/refreshtoken/webstore request. Permissions This endpoint does not require permissionshttps://Content-Type (string) required
Accept (string) required
vtex_id/servers_api_vtexid_refreshtoken_webstoreNo description availableNo parameters
vtex_id/post_api_vtexid_refreshtoken_webstoreReturns a valid refresh token and authentication token VtexIdclientAutCookie as cookies. Permissions This endpoint does not require permissionshttps://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3.Content-Type (string) required
Accept (string) required
Host (string) required
data: {
. fingerprint (string)
} (object) required
vtex_id/get_api_vtexid_organization_units_by_unit_id_settingsReturns the authentication methods configured for an organization unit, such as password login and external identity provider SSO, including whether each method is enabled. ⚠️ This feature is only available for stores using B2B Buyer Portalhttps://help.vtex.com/en/docs/tutorials/b2b-buyer-portal, which is currently available to select accounts. ℹ️ These endpoints configure authentication methods for an organization unit for example password or SSO. To manage unit hierarchy and membership,unitId (string)
Accept (string) required
vtex_id/post_api_vtexid_organization_units_by_unit_id_settingsDefines authentication settings for an organization unit, for example enabling or disabling SSO for a configured external identity provider. Send each method to change using its display name and desired status. ⚠️ This feature is only available for stores using B2B Buyer Portalhttps://help.vtex.com/en/docs/tutorials/b2b-buyer-portal, which is currently available to select accounts. ℹ️ These endpoints configure authentication methods for an organization unit for example password or SSO. TounitId (string)
Content-Type (string) required
Accept (string) required
data: {
. settings (array)
} (object) required
vtex_id/patch_api_vtexid_organization_units_by_unit_id_settingsPartially updates authentication configurations that already exist for the organization unit for example changing status. This endpoint doesn't create new authentication methods; use POST Set organization unit authentication settingshttps://developers.vtex.com/docs/api-reference/vtex-id-api post-/api/vtexid/organization-units/-unitId-/settings to define or add them. Send a settings array in which each object specifies the configuration type for example OAuth and the desired status for that exunitId (string)
Content-Type (string) required
Accept (string) required
data: {
. settings (array)
} (object) required
vtex_id/delete_api_vtexid_organization_units_by_unit_id_settingsDeletes only the authentication configuration entries listed in the request body settings array each entry is identified by type, for example OAuth. Other organization unit authentication configuration is not removed. Use with care when deleting unit-specific SSO configuration. ⚠️ This feature is only available for stores using B2B Buyer Portalhttps://help.vtex.com/en/docs/tutorials/b2b-buyer-portal, which is currently available to select accounts. ℹ️ These endpoints configure authenticatiunitId (string)
Content-Type (string) required
Accept (string) required
data: {
. settings (array)
} (object) required
vtex_id/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
vtex_shipping_network/post_by_app_name_vby_app_version_by_account_by_workspace_notifyNotifies the carrier about a dispatch order by calling the vtex.carrier-notifier app. When the call is made, the following data is sent: - Dispatched packages information. - Fiscal information about the carrier notified. - Carrier's contact email. The call's response includes all tracking data and each package's ID generated by the notification made to the carrier. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must haveapp_name (string)
app_version (string)
account (string)
workspace (string)
data: {
. account
. email (string)
. dispatchOrder
} (object) required
vtex_shipping_network/post_by_app_name_vby_app_version_by_account_by_workspace_trackingThis endpoint is called by the hub to obtain the tracking events of a series of tracking numbers. This call's request updates the events of a list of tracking codes, for packages that are still pending delivery. The expected response is an object contaning the tracking information and the package's notification ID for every packageID. Permissions Any user or API keyhttps://developers.vtex.com/docs/guides/api-authentication-using-api-keys must have at least one of the appropriate Licenapp_name (string)
app_version (string)
account (string)
workspace (string)
data (array) required
vtex_shipping_network/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)
mtls/post_api_edge_private_certificates_signℹ️ This feature is part of VTEX Shieldhttps://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh. If you're already a VTEX client and would like to adopt VTEX Shield for your business, contact our Commercial Supporthttps://help.vtex.com/es/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ. Additional fees may apply. If you're not a VTEX client yet but are interested in this solution, please complete our contact formhttps://vtex.com/us-en/contact/. Requests a certiContent-Type (string) required
Accept (string) required
mtls/delete_api_edge_private_certificates_by_serial_numberℹ️ This feature is part of VTEX Shieldhttps://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh. If you're already a VTEX client and would like to adopt VTEX Shield for your business, contact our Commercial Supporthttps://help.vtex.com/es/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ. Additional fees may apply. If you're not a VTEX client yet but are interested in this solution, please complete our contact formhttps://vtex.com/us-en/contact/. Revokes a previoserialNumber (string)
Content-Type (string) required
Accept (string) required
mtls/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body (undefined)
_headers (object)

Webhook Events​

This connector emits 16 events back to your workflow. To receive one, create a hook whose path is <connection-name>/<event> — the connection name you configured plus the event from the table below.

EventDescription
order-createdOrder created in the platform.
order-acceptedOrder received by the seller.
on-order-completedPurchase processed at checkout; order data is complete.
payment-pendingWaiting for payment confirmation.
payment-approvedOrder payment approved.
window-to-cancelCancellation window after payment approval.
authorize-fulfillmentInternal approval of order handling.
waiting-ffmt-authorizationSeller waiting for marketplace fulfillment authorization.
ready-for-handlingOrder ready for the seller to start handling.
start-handlingOrder handling started.
handlingItems reserved; waiting for invoice notification.
invoiceInvoice under verification.
invoicedOrder invoiced and handed to the carrier.
cancellation-requestedOrder cancellation requested.
cancelOrder cancellation in progress.
canceledOrder canceled.