JUMP TOUsing this API ReferenceIntroductionUsing PostmanAntifraud ProviderAntifraud Provider Protocol - OverviewAntifraud FlowSend Antifraud Pre-Analysis Data (optional)postSend Antifraud DatapostList Antifraud Provider ManifestgetGet Antifraud StatusgetStop Antifraud Analysis (optional)deleteOAuth Flow1. Retrieve Tokenpost2. Redirectget3. Return to VTEXget4. Get CredentialsgetCatalog APICatalog API - OverviewProductGet Product and SKU IDsgetGet Product by IDgetUpdate ProductputGet Product and its general contextgetGet Product by RefIdgetGet Product's SKUs by Product IDgetGet Product Review Rate by Product IDgetCreate ProductpostProduct SpecificationGet Product Specification by Product IDgetUpdate Product Specification by Product IDpostGet Product Specification and its information by Product IDgetAssociate Product SpecificationpostDelete all Product SpecificationdeleteDelete Product SpecificationdeleteAssociate product specification using specification and group namesputSKUList all SKU IDsgetGet SKU and contextgetGet SKU by RefIdgetCreate SKUpostGet SkuId by RefIdgetGet SKU by Alternate IDgetGet SKU list by ProductIdgetRetrieve SkuId list by RefId listpostGet SKUgetUpdate SKUputSKU ComplementGet SKU Complement by SKU IDgetGet SKU Complements by Complement Type IDgetGet SKU complements by typegetCreate SKU ComplementpostGet SKU Complement by SKU Complement IDgetDelete SKU Complement by SKU Complement IDdeleteSKU EANGet SKU by EANgetGet EAN by SkuIdgetDelete all SKU EANdeleteCreate SKU EANpostDelete SKU EANdeleteSKU AttachmentAssociate SKU AttachmentpostDissociate attachments and SKUsdeleteGet SKU Attachment by SKU IDgetDelete SKU Attachment by SKU Attachment Association IDdeleteAssociate attachments to SKUpostDelete SKU ComplementdeleteSKU FileGet SKU FilegetCreate SKU FilepostDelete All SKU FiledeleteUpdate SKU FileputDelete SKU Image by File IDdeleteCopy All Files from an SKU to other SKUputDisassociate SKU FiledeleteSKU KitGet SKU Kit by SKU ID or Parent SKU IDgetCreate SKU KitpostDelete SKU Kit by SKU ID or Parent SKU IDdeleteGet SKU KitgetDelete SKU Kit by KitIddeleteSKU SellerGet SKU sellergetDelete an SKU seller associationpostChange Notification with Seller ID and Seller SKU IDpostChange Notification with SKU IDpostSKU ServiceUpdate SKU ServiceputDissociate SKU ServicedeleteAssociate SKU ServicepostSKU Service AttachmentAssociate SKU Service AttachmentpostDissociate Attachment by Attachment ID or SKU Service Type IDdeleteDissociate Attachment from SKU Service TypedeleteSKU Service TypeCreate SKU Service TypepostUpdate SKU Service TypeputDelete SKU Service TypedeleteSKU Service ValueCreate SKU Service ValuepostUpdate SKU Service ValueputDelete SKU Service ValuedeleteSKU SpecificationGet SKU SpecificationsgetAssociate SKU SpecificationpostUpdate SKU SpecificationputDelete all SKU SpecificationsdeleteDelete SKU SpecificationdeleteSKU SubcollectionGet Subcollection's SKUsgetAssociate SubCollection to SKUpostDelete SKU SubCollectiondeleteCategoryGet Category TreegetGet Category by IDgetUpdate CategoryputCreate CategorypostSimilar CategoryGet Similar Product CategorygetCreate Similar Product CategorypostDelete Similar Product CategorydeleteCategory SpecificationGet Specifications By Category IdgetGet Specifications Tree By Category IdgetCategory SubcollectionAssociate SubCollection to CategorypostDelete Category SubCollectiondeleteBrandGet Brand ListgetGet Brand List Per PagegetGet BrandgetCreate BrandpostGet Brand and contextgetUpdate BrandputDelete BranddeleteBrand SubcollectionAssociate SubCollection to BrandpostDelete Brand SubCollectiondeleteAttachmentGet attachmentgetUpdate attachmentputDelete attachmentdeleteCreate attachmentpostCollection BetaGet All CollectionsgetGet All Inactive CollectionsgetCreate CollectionpostGet Collections by search termsgetImport Collection file examplegetAdd products to Collection by imported filepostRemove products from Collection by imported filepostGet products from a collectiongetCollectionGet CollectiongetUpdate CollectionputDelete CollectiondeleteCollection CMSCreate CollectionpostSubcollectionGet Subcollection by Collection IDgetGet SubCollectiongetUpdate SubCollectionputDelete SubCollectiondeleteCreate SubCollectionpostReposition SKU on the SubCollectionpostSpecificationGet SpecificationgetUpdate SpecificationputCreate SpecificationpostSpecification FieldGet Specifications FieldgetCreate Specifications FieldpostUpdate Specifications FieldputSpecification Field ValueGet Specifications Field ValuegetGet Specifications Values By Field IdgetCreate Specifications Field ValuepostUpdate Specifications Field ValueputSpecification ValueGet Specification ValuegetUpdate Specification ValueputCreate Specification ValuepostSpecification GroupList Specifications Group by CategorygetGet Specifications GroupgetCreate Specification GrouppostCreate Specification GrouppostUpdate Specification GroupputUpdate Specification GroupputNon Structured SpecificationGet Specification Non StructuredgetDelete Specification Non StructureddeleteGet Specification Non Structured by SkuIdgetDelete Specification Non Structured by SkuIddeleteSales ChannelGet Sales Channel ListgetGet Sales Channel by IdgetSellerGet Seller ListgetGet Seller by IDgetUpdate SellerputCreate SellerpostGet Seller by IDgetSupplierCreate SupplierpostUpdate SupplierputDelete SupplierdeleteTrade PolicyGet Trade Policy by Product IDgetCreate Product to Trade PolicypostDelete Product to Trade PolicydeleteList all SKUs of a Trade PolicygetProduct IndexedGet Indexed InfogetCommercial ConditionsGet all commercial conditionsgetGet a commercial conditiongetCheckout APICheckout API - OvervieworderFormShopping cartCart simulationpostGet current cart or create a new onegetGet cart information by IDgetRemove all itemspostRemove all personal datagetUpdate cart itemspatchChange priceputIgnore profile datapatchCart installmentsgetCart attachmentsGet client profile by emailgetAdd client profilepostAdd shipping address and select delivery optionpostAdd client prefencespostAdd marketing datapostAdd payment datapostAdd merchant context datapostCustom dataSet multiple custom field valuesputSet single custom field valueputRemove single custom field valuedeleteConfigurationGet orderForm configurationgetUpdate orderForm configurationpostGet window to change sellergetUpdate window to change sellerpostFulfillmentList pickup points by locationgetGet address by postal codegetOrder placementPlace order from an existing cartpostPlace orderputProcess orderpostRegionGet sellers by regiongetCMS APIChange URI SchemaChange entire account (all websites)putChange specific websiteputCustomer Credit APICustomer Credit API - OverviewInvoicesSearch all invoicesgetRetrieve Invoice by IdgetChange InvoiceputCancel InvoicedeleteRetrieve invoice by creditAccountIdgetAccountSearch all accountsgetOpen an AccountpostRetrieve an Account by IdgetClose an AccountdeleteUpdate email and description of a accountputAccount statementsgetOpen or Change AccountputChange credit limit of an AccountputDecrease balance of an accountputCreate or Update SettlementputCreate a Pre AuthorizationpostCreate a Pre Authorization (using id)putCancel a Pre AuthorizationdeleteAdd an account HolderpostDelete an account holderdeleteChange tolerance of an accountputPartial or Total Refund a SettlementpostStore ConfigurationRetrieve store configurationgetCreate or change store configurationputGiftCard APIGiftCard API - OverviewGift CardCreate GiftCardpostGet GiftCard by IDgetGet GiftCard using JSONpostTransactionGet GiftCard TransactionsgetCreate GiftCard TransactionpostGet GiftCard Transaction by IDgetGet Transaction AuthorizationsgetGet Transaction CancellationsgetCancel GiftCard TransactionpostGet Transaction SettlementsgetSettle GiftCard TransactionpostGiftCard Hub APIGiftCard Hub API - OverviewProviderList All GiftCard ProvidersgetGet GiftCard Provider by IDgetCreate/Update GiftCard Provider by IDputDelete GiftCard Provider by IDdeleteTransactionCreate GiftCard in GiftCard ProviderpostGet GiftCard from GiftCard ProviderpostGet GiftCard from GiftCard Provider by IDgetList All GiftCard TransactionsgetCreate GiftCard TransactionpostGet GiftCard Transaction by IDgetGet GiftCard Authorization TransactiongetList All GiftCard Settlement TransactionsgetCreate GiftCard Settlement TransactionpostList All GiftCard Cancellation TransactionsgetCreate GiftCard Cancellation TransactionpostGiftcard Provider ProtocolGiftcard Provider Protocol - OverviewGift CardsList All GiftCardspostGet GiftCard by IDgetCreate GiftCardpostTransactionsCreate GiftCard TransactionpostList All GiftCard TransactionsgetGet GiftCard Transaction by IDgetGet GiftCard Transaction AuthorizationgetCreate GiftCard Transaction CancellationpostList All GiftCard Transactions CancellationsgetCreate GiftCard Transaction SettlementpostList All GiftCard Transactions SettlementsgetLicense Manager APILicense Manager API - OverviewUserGet UsergetCreate UserpostGet List of UsersgetRolesPut Roles in User/appKeyputGet Roles by User/appKeygetRemove Role from User/appKeydeleteGet List of RolesgetApp KeysCreate new appkeypostGet appKeys from accountgetUpdate appkeyputStoreGet StoresgetAccountGet information about accountgetLogistics APILogistics API - OverviewShipping PoliciesRetrieve shipping policy by IDgetDelete shipping policies by IDdeleteUpdate shipping policyputList shipping policiesgetCreate shipping policypostFreight ValuesCreate/update freight valuespostList freight valuesgetScheduled DeliveryRetrieve blocked delivery windowsgetAdd blocked delivery windowspostRemove blocked delivery windowspostSearch capacity reservations in time rangegetGet capacity reservation usage by windowgetDocksCreate/update dockpostList all docksgetList dock by IDgetDelete dockdeleteActivate dockpostDeactivate dockpostWarehousesCreate/update warehousepostList all warehousesgetList warehouse by IDgetRemove warehousedeleteActivate warehousepostDeactivate warehousepostInventoryList inventory by SKUgetList inventory per warehousegetUpdate inventory by SKU and warehouseputList inventory per dockgetList inventory per dock and warehousegetList inventory with dispatched reservationsgetHolidaysCreate/update holidayputList holiday by IDgetDelete holidaydeleteList all holidaysgetReservationsCreate reservationpostList reservation by IDgetConfirm reservationpostAcknowledgment reservationpostCancel reservationpostList reservation by warehouse and SKUgetSLACalculate SLApostPickup pointsList all pickup pointsgetCreate/Update Pickup PointputList Pickup Point By IDgetDelete Pickup PointdeleteList paged Pickup PointsgetPolygonsList paged polygonsgetCreate/update polygonputList polygon by IDgetDelete polygondeleteMarketplace APIMarketplace API overviewNotificationNotify marketplace of price updatepostNotify marketplace of inventory updatepostSKU Approval SettingsGet autoApprove Status in Account SettingsgetActivate autoApprove in Marketplace's AccountputGet Account's Approval SettingsgetSave Account's Approval SettingsputGet Seller's Approval SettingsgetSave Seller's Approval SettingsputActivate autoApprove Setting for a SellerputGet SuggestionsGet all SKU suggestionsgetGet SKU Suggestion by IDgetManage SuggestionsSend SKU SuggestionputDelete SKU SuggestiondeleteGet VersionsGet all VersionsgetGet Version by IDgetMatch Received SKUsMatch Received SKUs individuallyputMatch Multiple Received SKUsputMatched OffersGet Matched Offers ListgetGet Matched Offer's Data by SKU IDgetGet Matched Offer's Data by Product IDgetSeller InviteInvite Seller LeadpostList Seller LeadsgetAccept Seller LeadputGet Seller Lead's Data by IdgetDelete Seller LeaddeleteCreate Seller From LeadputResend Seller Lead InviteputSeller CommissionsUpsert Seller Commissions in BulkputList Seller Commissions by seller IDgetUpsert Seller Commissions by Category IDputRemove Seller Commissions by Category IDdeleteGet Seller Commissions by Category IDgetSellersConfigure Seller AccountputList SellersgetUpdate Seller by Seller IDpatchGet Seller data by IDgetMarketplace ProtocolExternal SellerFulfillment simulationpostOrder placementpostAuthorize fulfillmentpostMarketplace order cancellationpostSend invoicepostSend tracking informationpostUpdate tracking statuspostCancel order in marketplacepostExternal MarketplaceVTEX Mapper RegistrationpostSend Category Mapping to VTEX MapperpostPlace fulfillment orderpostAuthorize dispatch for fulfillment orderpostNew Order IntegrationpostUpdate Order StatusputMasterData API - v1MasterData API - v1 - OverviewAttachmentsRetrieve attachmentgetSave attachmentpostClustersValidate Document by ClusterspostData EntitiesList data entitiesgetGet data entity structuregetDocumentsCreate new documentpostCreate or update entire documentputCreate or update partial documentpatchGet documentgetUpdate entire documentputUpdate partial documentpatchDelete documentdeleteScorePut scoresputPut score by fieldputDelete score by fielddeleteScrollScroll documentsgetSearchSearch documentsgetVersionsList versionsgetGet versiongetPut versionputMaster Data API - v2Master Data API - v2 - OverviewDocumentsCreate new documentpostCreate or update entire documentputCreate or update partial documentpatchGet documentgetUpdate entire documentputUpdate partial documentpatchDelete documentdeleteSearchSearch documentsgetScrollScroll documentsgetSchemasGet schemasgetGet schema by namegetSave schema by nameputIndicesGet indicesgetPut indicesputGet index by namegetDelete index by namedeleteClustersValidate document by clusterspostVersionsList versionsgetGet versiongetPut versionputMessage Center APIDKIM ConfigurationGenerate DKIM keyspostOrders APIOrders API - OverviewOrdersGet ordergetList ordersgetStart handling orderpostCancel orderpostRegister change on orderpostInvoiceOrder invoice notificationpostUpdate order's partial invoice (send tracking number)patchTrackingUpdate order tracking statusputConversationRetrieve order conversationgetPaymentRetrieve payment transactiongetSend payment notificationpostFeed v3Get feed configurationgetCreate or update feed configurationpostDelete feed configurationdeleteRetrieve feed itemsgetCommit feed itemspostTest JSONata expressionpostOrder hookGet hook configurationgetCreate or update hook configurationpostDelete hook configurationdeleteUser ordersRetrieve user's ordersgetRetrieve user order detailsgetChange sellerGet window to change sellergetUpdate window to change sellerpostPayment Provider ProtocolPayment Provider Protocol - OverviewPayment FlowList Payment MethodsgetList Payment Provider ManifestgetCreate PaymentpostCancel PaymentpostSettle PaymentpostRefund PaymentpostInbound Request (BETA)postConfiguration FlowCreate Authorization TokenpostProvider AuthenticationgetGet CredentialsgetPayments Gateway APIPayments Gateway API - OverviewInstallmentsInstallments optionsgetConfigurationAffiliationsgetInsert AffiliationpostUpdate AffiliationputAffiliation By IdgetRulesgetInsert RulepostRule By IdgetRule By IdputDelete RuledeleteAvailable Payment MethodsgetTransaction Process1. Starts a new transactionpost2.1 Send Payments Information Publicpost2.2 Send Payments With Saved Credit Cardpost3. Send Additional DatapostDo authorizationpostTransaction DetailsgetPayment DetailsgetTransaction Settlement DetailsgetTransaction FlowSettle the transactionpostRefund the transactionpostCancel the transactionpostPrice Simulations APIPrice Simulations API - OverviewCustom PricesGet custom prices schemagetCreate or Update custom prices schemapostSession ManagementUpdate Order ConfigurationpostPrice AssociationGet price association by IDgetCreate price associationpostUpdate price association by IDputDisassociate price association by IDdeletePricing APIPricing API - OverviewPrice TablesCreate rules for a price tablepostGet rules for a price tablegetUpdate rules for a price tableputPrices and Fixed PricesGet PricegetDelete PricedeleteCreate or update base or fixed pricesputGet Fixed PricesgetCreate or update fixed prices on a price table or trade policypostGet Fixed Prices on a price tablegetDelete fixed prices on a price table (or trade policy)deleteGet Computed Price by price tablegetPricing ConfigGet Pricing ConfiggetGets Pricing v2 Active StatusgetPromotions & Taxes APIPromotions & Taxes API - OverviewCouponsCreate multiple couponspostCreate couponpostGet coupon by coupon codegetGet archived coupon by coupon codegetArchive coupon by coupon codepostUpdate couponpostGet all couponsgetCoupon Massive GenerationpostGet coupon usagegetUnarchive coupon by coupon codepostPromotionsGet All PromotionsgetGet Promotion By IDgetCreate Or Update PromotionpostCreate Multiple SKU PromotionpostUpdate Multiple SKU PromotionputArchive a PromotionpostUnarchive a PromotionpostCampaign AudiencesGet campaign audience configurationgetCreate campaign audiencepostSearch APISearch API - OverviewCrossSellingGet Product Search of Who Saw Also SawgetGet Product Search of Who Saw Also BoughtgetGet Product Search of Who Bought Also BoughtgetGet Product Search of Show TogethergetGet Product Search of AccessoriesgetGet Product Search of SimilarsgetGet Product Search of SuggestionsgetSearchSearch for productsgetSearch for Products with Filter, Order and PaginationgetSearch Product by Product URLgetOffersSearch Product offersgetSearch SKU offersgetFacetsGet Category FacetsgetSearch by Store FacetsgetAutocompleteProduct Search AutocompletegetSession Manager APISession Manager API - OverviewSessionsCreate new sessionpostGet SessiongetEdit sessionpatchSegmentGet SegmentgetSubscriptions API (v2 - DEPRECATED)Subscriptions API - v2 - OverviewSubscriptionsRetrieve subscription by IDgetUpdate Subscriptions by SubscriptionIdpatchCancel Subscriptions by SubscriptionIdpatchGet Subscription ListgetRetrieve customer's subscriptionsgetInsert Addresses for SubscriptionpostGet frequency options by subscriptionIdgetSubscription GroupGet Subscription by groupIdgetUpdate Subscription by groupIdpatchList All subscription groupsgetGet subscription group listgetGet Simulation by subscription-groupgetCancel Subscription by groupIdpatchAdd Subscription item by groupIdpostGet addresses by groupIdgetInsert Addresses by groupIdpostGet payment System by groupIdgetGet frequency options by groupIdgetRetry subscription by groupIdpostGet Conversation Message by groupIdgetList 'Will create' by groupIdgetList Subscription group's ConfigurationgetGet Next purchasegetReportRetrieve Subscription report by StatusgetRetrieve Subscription report by dategetRetrieve Subscription report by schedulegetRetrieve Subscription report by order dategetRequest report by updategetGet report status by IDgetSettingsGet Subscriptions SettingsgetEdit Subscriptions settingspostSubscriptions API (v3)Subscriptions API - v3 - OverviewCyclesGet cycle detailsgetList cyclesgetRetry cyclepostPlansList plansgetGet plan detailsgetReportsList report templatesgetGet report document detailsgetGenerate reportpostSubscriptionsGet subscription detailsgetUpdate subscriptionpatchList subscriptionsgetCreate subscriptionpostRemove item from subscriptiondeleteEdit item on subscriptionpatchAdd item to subscriptionpostCalculate the current prices for a specific subscriptionpostCalculate the current prices for the provided subscription templatepostGet conversation messagesgetSettingsGet Subscription SettingsgetEdit Subscriptions settingspostVTEX Do APIVTEX Do API - OverviewNoteCreate NotepostGet Notes by orderIdgetRetrieve NotegetTaskCreate TaskpostList tasksgetRetrieve TaskgetUpdate TaskputAdd Comment on a TaskpostVTEX Tracking APIsVTEX Tracking - OverviewAuthenticationAsynchronous LoginpostDelivery ServicesPost Delivery ServicepostGet Delivery Services ListgetGet Delivery Service by IDgetPost Delivery Service With Route SchedulingpostGet Delivery Services List by RoutegetGet Delivery Service by InvoicegetVTEX Shipping Network - HubsVTEX Shipping Network - OverviewNotificationNotify Carrier with ApppostTrackingTracking Events with ApppostPricing HubPricing Hub - OverviewPricing Hub PricesGet PricespostConfigure External Price SourceputPolicies System APIPolicy Engine API - OverviewPolicyGet Policy ListgetEvaluate PoliciespostGet Policy by IDgetCreate PolicypostUpdate PolicyputDelete Policy by IDdeleteIntelligent Search APIIntelligent Search API - OverviewAutocompleteGet list of the 10 most searched termsgetGet list of suggested terms and attributes similar to the search termgetProduct List PageGet attempt of correction of a misspelled termgetGet list of banners registered for querygetGet list of suggested terms similar to the search termgetGet list of products for a querygetGet list of the possible facets for a given querygetReviews and Ratings APIReviews and Ratings API - OverviewRatingGet Product RatinggetReviewGet Review by Review IDgetDelete ReviewdeleteUpdate a ReviewpatchGet a list of ReviewsgetCreate Multiple ReviewspostDelete Multiple ReviewsdeleteCreate a ReviewpostGet Brand and contextget https://{accountName}.{environment}.com.br/api/catalog/pvt/brand/{brandId}Retrieves information about a specific Brand and its context