VTEX
VTEX is a global enterprise digital commerce platform that provides end-to-end solutions for businesses to create, manage, and scale their online stores. Founded in Brazil, VTEX serves thousands of merchants across 38 countries with capabilities spanning catalog management, checkout, payments, logistics, marketplace, promotions, search, and customer identity. The platform offers an extensive API ecosystem enabling headless commerce, composable architectures, and deep integrations with third-party tools and marketplaces.
Real signal across most facets with visible, nameable gaps — the contract exists but is thin, or the portal is good while governance and commercial terms are absent.
API Evangelist profiles VTEX the way a machine reads it — 1282 machine-readable artifacts across 142 APIs, pulled from the provider's own public surface and indexed so a developer, an analyst, or an AI agent can evaluate it against every other provider on the network.
Every provider in the network is reduced to the same set of machine-readable artifacts — OpenAPI contracts, event specifications, GraphQL schemas, runnable collections, pricing and rate-limit signals, security posture, OAuth scopes, and the agent surfaces (MCP servers and skills) that let software drive the API on its own. We profile them because the interface is the part of a company you can actually inspect: it is a truer signal of what a provider does than any marketing page. From those artifacts we compute the Kin Score — VTEX scores 54.9/100 (developing), with a separate agent-readiness read of 48/100 (agent ready). The full breakdown is below, followed by every artifact we hold — each card links through to its machine-readable definition on apis.io.
Kin Score
This is the API Evangelist rating — a single, repeatable read computed from the artifacts on this page. Green fill is points earned; the red track is points possible, so every bar shows earned-versus-possible at a glance.
Kin Score
How this is scored →scored 2026-07-27 · rubric v0.5
How we profile VTEX
Each block below is one kind of artifact we hold for VTEX. For each we say what it is and why it earns a place in the profile, then list every one we've indexed — capped at two rows, scroll within the panel for the rest.
APIs 142
Each API is captured as its own OpenAPI definition — every operation, parameter, and response. This is the single most useful machine-readable description of what an API does, and it's what lets us score, lint, mock, and generate against it without asking the provider for anything.
Individual APIs this provider publishes, each with its own machine-readable definition.
VTEX Account API
The Account API from VTEX — 13 operation(s) for account.
VTEX Addresses API
The Addresses API from VTEX — 6 operation(s) for addresses.
VTEX Anti-Fraud Flow API
The Anti-Fraud Flow API from VTEX — 6 operation(s) for anti-fraud flow.
VTEX App Keys API
The App Keys API from VTEX — 2 operation(s) for app keys.
VTEX Attachment API
The Attachment API from VTEX — 3 operation(s) for attachment.
VTEX Authentication API
The Authentication API from VTEX — 7 operation(s) for authentication.
VTEX Autocomplete API
The Autocomplete API from VTEX — 4 operation(s) for autocomplete.
VTEX Brand API
The Brand API from VTEX — 7 operation(s) for brand.
VTEX Bulk Import API
The Bulk Import API from VTEX — 3 operation(s) for bulk import.
VTEX Carriers API
The Carriers API from VTEX — 2 operation(s) for carriers.
VTEX Cart Attachments API
The Cart Attachments API from VTEX — 7 operation(s) for cart attachments.
VTEX Category API
The Category API from VTEX — 6 operation(s) for category.
VTEX Category Specification API
The Category Specification API from VTEX — 2 operation(s) for category specification.
VTEX Change Order (Beta) API
The Change Order (Beta) API from VTEX — 5 operation(s) for change order (beta).
VTEX Change Seller API
The Change Seller API from VTEX — 1 operation(s) for change seller.
VTEX Change URI Schema API
Changes CMS URI
VTEX Clusters API
The Clusters API from VTEX — 1 operation(s) for clusters.
VTEX Collection Beta API
The Collection Beta API from VTEX — 8 operation(s) for collection beta.
VTEX Commercial Conditions API
The Commercial Conditions API from VTEX — 2 operation(s) for commercial conditions.
VTEX Configuration API
The Configuration API from VTEX — 8 operation(s) for configuration.
VTEX Configuration Flow API
The Configuration Flow API from VTEX — 3 operation(s) for configuration flow.
VTEX Conversation API
The Conversation API from VTEX — 1 operation(s) for conversation.
VTEX Coupons API
The Coupons API from VTEX — 9 operation(s) for coupons.
VTEX CrossSelling API
The CrossSelling API from VTEX — 7 operation(s) for crossselling.
VTEX Custom Data API
The Custom Data API from VTEX — 2 operation(s) for custom data.
VTEX Cycles API
The Cycles API from VTEX — 3 operation(s) for cycles.
VTEX Data Subject Rights API
The Data Subject Rights API from VTEX — 1 operation(s) for data subject rights.
VTEX Delivery Services API
The Delivery Services API from VTEX — 4 operation(s) for delivery services.
VTEX DKIM Configuration API
The DKIM Configuration API from VTEX — 1 operation(s) for dkim configuration.
VTEX Docks API
The Docks API from VTEX — 4 operation(s) for docks.
VTEX Documents API
The Documents API from VTEX — 2 operation(s) for documents.
VTEX Events API
The Events API from VTEX — 1 operation(s) for events.
VTEX External Marketplace API
The External Marketplace API from VTEX — 12 operation(s) for external marketplace.
VTEX External Seller API
The External Seller API from VTEX — 8 operation(s) for external seller.
VTEX Facets API
The Facets API from VTEX — 2 operation(s) for facets.
VTEX Feed V2 (Deprecated) API
The Feed V2 (Deprecated) API from VTEX — 1 operation(s) for feed v2 (deprecated).
VTEX Feed V3 API
The Feed V3 API from VTEX — 3 operation(s) for feed v3.
VTEX Freight Values API
The Freight Values API from VTEX — 2 operation(s) for freight values.
VTEX Fulfillment API
The Fulfillment API from VTEX — 2 operation(s) for fulfillment.
VTEX Get Suggestions API
The Get Suggestions API from VTEX — 2 operation(s) for get suggestions.
VTEX Get Versions API
The Get Versions API from VTEX — 2 operation(s) for get versions.
VTEX Gift Card API
The Gift Card API from VTEX — 3 operation(s) for gift card.
VTEX Gift Cards API
The Gift Cards API from VTEX — 3 operation(s) for gift cards.
VTEX Gift List API
The Gift List API from VTEX — 1 operation(s) for gift list.
VTEX Holidays API
The Holidays API from VTEX — 2 operation(s) for holidays.
VTEX Indices API
The Indices API from VTEX — 2 operation(s) for indices.
VTEX Installments API
The Installments API from VTEX — 1 operation(s) for installments.
VTEX Inventory API
The Inventory API from VTEX — 9 operation(s) for inventory.
VTEX Invoice API
The Invoice API from VTEX — 3 operation(s) for invoice.
VTEX Invoices API
The Invoices API from VTEX — 5 operation(s) for invoices.
VTEX Legacy Collection API
The Legacy Collection API from VTEX — 2 operation(s) for legacy collection.
VTEX Legacy Subcollection API
The Legacy Subcollection API from VTEX — 10 operation(s) for legacy subcollection.
VTEX Manage Suggestions API
The Manage Suggestions API from VTEX — 1 operation(s) for manage suggestions.
VTEX Match Received SKUs API
The Match Received SKUs API from VTEX — 2 operation(s) for match received skus.
VTEX Matched Offers API
The Matched Offers API from VTEX — 3 operation(s) for matched offers.
VTEX Non-Structured Specification API
The Non-Structured Specification API from VTEX — 2 operation(s) for non-structured specification.
VTEX Note API
The Note API from VTEX — 2 operation(s) for note.
VTEX Notification API
The Notification API from VTEX — 3 operation(s) for notification.
VTEX OAuth Flow API
The OAuth Flow API from VTEX — 4 operation(s) for oauth flow.
VTEX Offer Management API
The Offer Management API from VTEX — 11 operation(s) for offer management.
VTEX Offers API
The Offers API from VTEX — 2 operation(s) for offers.
VTEX Order Hook API
The Order Hook API from VTEX — 1 operation(s) for order hook.
VTEX Order Placement API
The Order Placement API from VTEX — 3 operation(s) for order placement.
VTEX Orders API
The Orders API from VTEX — 10 operation(s) for orders.
VTEX Pages API
The Pages API from VTEX — 3 operation(s) for pages.
VTEX Payment API
The Payment API from VTEX — 3 operation(s) for payment.
VTEX Payment Flow API
The Payment Flow API from VTEX — 6 operation(s) for payment flow.
VTEX Pickup Points API
The Pickup Points API from VTEX — 3 operation(s) for pickup points.
VTEX Plans API
The Plans API from VTEX — 2 operation(s) for plans.
VTEX Policy API
The Policy API from VTEX — 3 operation(s) for policy.
VTEX Polygons API
The Polygons API from VTEX — 2 operation(s) for polygons.
VTEX Price Tables API
The Price Tables API from VTEX — 3 operation(s) for price tables.
VTEX Prices and Fixed Prices API
The Prices and Fixed Prices API from VTEX — 4 operation(s) for prices and fixed prices.
VTEX Pricing Configuration API
The Pricing Configuration API from VTEX — 2 operation(s) for pricing configuration.
VTEX Pricing Hub Prices API
The Pricing Hub Prices API from VTEX — 2 operation(s) for pricing hub prices.
VTEX Product API
The Product API from VTEX — 11 operation(s) for product.
VTEX Product Indexing API
The Product Indexing API from VTEX — 1 operation(s) for product indexing.
VTEX Product List Page API
The Product List Page API from VTEX — 4 operation(s) for product list page.
VTEX Product Specification API
The Product Specification API from VTEX — 4 operation(s) for product specification.
VTEX Profiles API
The Profiles API from VTEX — 5 operation(s) for profiles.
VTEX Prospects API
The Prospects API from VTEX — 4 operation(s) for prospects.
VTEX Provider API
The Provider API from VTEX — 2 operation(s) for provider.
VTEX Purchase Information API
The Purchase Information API from VTEX — 2 operation(s) for purchase information.
VTEX Rating API
The Rating API from VTEX — 1 operation(s) for rating.
VTEX Region API
The Region API from VTEX — 1 operation(s) for region.
VTEX Reports API
The Reports API from VTEX — 3 operation(s) for reports.
VTEX Reservations API
The Reservations API from VTEX — 6 operation(s) for reservations.
VTEX Review API
The Review API from VTEX — 3 operation(s) for review.
VTEX Roles API
The Roles API from VTEX — 3 operation(s) for roles.
VTEX Sales Channel API
The Sales Channel API from VTEX — 2 operation(s) for sales channel.
VTEX Sales Channel Mapping API
The Sales Channel Mapping API from VTEX — 1 operation(s) for sales channel mapping.
VTEX Scheduled Delivery API
The Scheduled Delivery API from VTEX — 5 operation(s) for scheduled delivery.
VTEX Schemas API
The Schemas API from VTEX — 4 operation(s) for schemas.
VTEX Scroll API
The Scroll API from VTEX — 1 operation(s) for scroll.
VTEX Search API
The Search API from VTEX — 4 operation(s) for search.
VTEX Segment API
The Segment API from VTEX — 1 operation(s) for segment.
VTEX Seller API
The Seller API from VTEX — 4 operation(s) for seller.
VTEX Seller Commissions API
The Seller Commissions API from VTEX — 2 operation(s) for seller commissions.
VTEX Seller Invite API
The Seller Invite API from VTEX — 4 operation(s) for seller invite.
VTEX Sellers API
The Sellers API from VTEX — 2 operation(s) for sellers.
VTEX Service Integration API
These endpoints must be developed to integrate with the Lastmile Pick and Pack Last Mile Protocol API.
VTEX Session API
The Session API from VTEX — 1 operation(s) for session.
VTEX Settings API
The Settings API from VTEX — 1 operation(s) for settings.
VTEX Shipping Policies API
The Shipping Policies API from VTEX — 2 operation(s) for shipping policies.
VTEX Shipping Updates API
This endpoint will allow the carriers to update an ongoing shipping service.
VTEX Shopping Cart API
The Shopping Cart API from VTEX — 11 operation(s) for shopping cart.
VTEX Similar Category API
The Similar Category API from VTEX — 2 operation(s) for similar category.
VTEX SKU API
The SKU API from VTEX — 10 operation(s) for sku.
VTEX SKU Approval Settings API
The SKU Approval Settings API from VTEX — 5 operation(s) for sku approval settings.
VTEX SKU Attachment API
The SKU Attachment API from VTEX — 4 operation(s) for sku attachment.
VTEX SKU Bindings API
The SKU Bindings API from VTEX — 11 operation(s) for sku bindings.
VTEX SKU Complement API
The SKU Complement API from VTEX — 5 operation(s) for sku complement.
VTEX SKU EAN API
The SKU EAN API from VTEX — 3 operation(s) for sku ean.
VTEX SKU File API
The SKU File API from VTEX — 4 operation(s) for sku file.
VTEX SKU Kit API
The SKU Kit API from VTEX — 2 operation(s) for sku kit.
VTEX SKU Seller API
The SKU Seller API from VTEX — 4 operation(s) for sku seller.
VTEX SKU Service API
The SKU Service API from VTEX — 2 operation(s) for sku service.
VTEX SKU Service Attachment API
The SKU Service Attachment API from VTEX — 2 operation(s) for sku service attachment.
VTEX SKU Service Type API
The SKU Service Type API from VTEX — 2 operation(s) for sku service type.
VTEX SKU Service Value API
The SKU Service Value API from VTEX — 2 operation(s) for sku service value.
VTEX SKU Specification API
The SKU Specification API from VTEX — 3 operation(s) for sku specification.
VTEX SLA API
The SLA API from VTEX — 1 operation(s) for sla.
VTEX Specification API
The Specification API from VTEX — 2 operation(s) for specification.
VTEX Specification Field API
The Specification Field API from VTEX — 2 operation(s) for specification field.
VTEX Specification Field Value API
The Specification Field Value API from VTEX — 3 operation(s) for specification field value.
VTEX Specification Group API
The Specification Group API from VTEX — 4 operation(s) for specification group.
VTEX Specification Value API
The Specification Value API from VTEX — 2 operation(s) for specification value.
VTEX Store Configuration API
The Store Configuration API from VTEX — 1 operation(s) for store configuration.
VTEX Stores API
The Stores API from VTEX — 1 operation(s) for stores.
VTEX Subscriptions API
The Subscriptions API from VTEX — 7 operation(s) for subscriptions.
VTEX Supplier API
The Supplier API from VTEX — 2 operation(s) for supplier.
VTEX Task API
The Task API from VTEX — 3 operation(s) for task.
VTEX Tracking API
The Tracking API from VTEX — 2 operation(s) for tracking.
VTEX Trade Policy API
The Trade Policy API from VTEX — 3 operation(s) for trade policy.
VTEX Transaction API
The Transaction API from VTEX — 13 operation(s) for transaction.
VTEX Transaction Flow API
The Transaction Flow API from VTEX — 3 operation(s) for transaction flow.
VTEX Transaction Process API
The Transaction Process API from VTEX — 8 operation(s) for transaction process.
VTEX Transactions API
The Transactions API from VTEX — 5 operation(s) for transactions.
VTEX User Orders API
The User Orders API from VTEX — 2 operation(s) for user orders.
VTEX Users API
The Users API from VTEX — 3 operation(s) for users.
VTEX Versions API
The Versions API from VTEX — 2 operation(s) for versions.
VTEX Warehouses API
The Warehouses API from VTEX — 4 operation(s) for warehouses.
Scroll within the panel for all 142 ·
Pricing Plans 1
Pricing is part of the interface. Machine-readable plans tell you what a tier costs and includes before you commit — one of the six things the Kin Score reads for commercial clarity.
Published pricing tiers and plan structures.
Vtex Plans Pricing
PLANSRate Limits 1
Rate limits are the difference between a demo that works and a production integration that doesn't fall over. Publishing them is an operational-transparency signal — and a hard requirement for any agent that plans its own throughput.
Documented rate limits and quota policies.
Vtex Rate Limits
RATE LIMITSFinOps 1
Cost, billing, and metering signals let a buyer model the financial operations of an API before it's live. We profile them for the same reason we profile pricing: the money is part of the contract.
Cost, billing, and metering signals for API financial operations.
Vtex Finops
FINOPSFeatures 16
The notable capabilities this provider advertises, captured as structured features so they can be searched and compared instead of read one landing page at a time.
Notable capabilities this provider offers.
Scroll within the panel for all 16 ·
Semantic Vocabularies 1
JSON-LD contexts give the data shared meaning across APIs. We profile them because semantics are what let a machine reconcile 'customer' here with 'customer' somewhere else.
JSON-LD contexts and semantic vocabularies used across these APIs.
Vtex Context
JSON-LDSpectral Rules 2
Governance rulesets we run against this provider's specs — the automated checks behind parts of the score. Profiling them makes the quality bar explicit and re-runnable, not a matter of opinion.
VTEX API Rules
SPECTRALVTEX API Rules
SPECTRALJSON Schema 655
Standalone JSON Schema definitions describe the data models behind the API. We profile them so the shapes are validatable on their own — useful long after a single request is forgotten.
Standalone JSON Schema definitions for this provider's data models.
1.CreateanewtransactionRequest
JSON SCHEMA1.RetrieveToken
JSON SCHEMA1.RetrieveTokenRequest
JSON SCHEMA200_OK
JSON SCHEMA2.SendPaymentsPublicRequest
JSON SCHEMA2.SendPaymentsWithSavedCreditCardRequest
JSON SCHEMA3.GetCredentials
JSON SCHEMA401_Unauthorized
JSON SCHEMA4.DoauthorizationRequest
JSON SCHEMAAccount
JSON SCHEMAaccountable
JSON SCHEMAAccountResponse
JSON SCHEMAAction
JSON SCHEMAAddCommentRequest
JSON SCHEMAAdditionalInfo
JSON SCHEMAAdditionalInfoV2
JSON SCHEMAAddLogRequest
JSON SCHEMAAddress
JSON SCHEMAAddress1
JSON SCHEMAAddress2
JSON SCHEMAAddress4
JSON SCHEMAid
JSON SCHEMAAddress metadata
JSON SCHEMAAddressStart
JSON SCHEMAAffiliationResponse
JSON SCHEMAAgent
JSON SCHEMAallcarrier
JSON SCHEMAAlternateIds
JSON SCHEMAAntifraud
JSON SCHEMAAplicativosDeTV
JSON SCHEMAAppKeyItems
JSON SCHEMAApproveAntifraudAnalysisResponse
JSON SCHEMAApproveorder
JSON SCHEMAAssignee
JSON SCHEMAAttachment
JSON SCHEMAAttachmentRequest
JSON SCHEMAAttachmentResponse
JSON SCHEMAAuthorization
JSON SCHEMAAutocompleteSearchSuggestions
JSON SCHEMAAvailable Sales Channel
JSON SCHEMABalance
JSON SCHEMABanners
JSON SCHEMABillingInfoResponse
JSON SCHEMABrand
JSON SCHEMABrandCreateUpdate
JSON SCHEMABrandGet
JSON SCHEMABRL
JSON SCHEMABRL1
JSON SCHEMABulkUpsertSellerCommissionsRequest
JSON SCHEMAbundleItemsItem
JSON SCHEMABusinessHour
JSON SCHEMABuyer
JSON SCHEMACalculateSLARequest
JSON SCHEMACancelChangeStoppedonError
JSON SCHEMACancellation
JSON SCHEMACancellations
JSON SCHEMACancelOngoingServiceRequest
JSON SCHEMACancelPaymentRequest
JSON SCHEMACancelServiceRequest
JSON SCHEMACancelServiceResponse
JSON SCHEMACancelthetransactionRequest
JSON SCHEMACapabilities
JSON SCHEMACarrier
JSON SCHEMAcarrierbyid
JSON SCHEMACarrierResponse
JSON SCHEMACart
JSON SCHEMACart1
JSON SCHEMACart2
JSON SCHEMACartProduct
JSON SCHEMACategoriesTree
JSON SCHEMACategory
JSON SCHEMACategorySpecification
JSON SCHEMAChangesAttachment
JSON SCHEMAChangesDatum
JSON SCHEMAChild
JSON SCHEMAChild1
JSON SCHEMASearch Click
JSON SCHEMAClient
JSON SCHEMAClientProfile
JSON SCHEMAClientProfileData
JSON SCHEMACommertialOffer
JSON SCHEMACommititemfeedorderstatusRequest
JSON SCHEMAConfigExternalPriceSourceRequest
JSON SCHEMAConfirmitemfeedorderstatusRequest
JSON SCHEMAConnector
JSON SCHEMAConnectorResponses
JSON SCHEMACorrection
JSON SCHEMACountry
JSON SCHEMACountryResponse
JSON SCHEMAAddress request body
JSON SCHEMACreateAuthorizationTokenRequest
JSON SCHEMACreateCategoryRequest
JSON SCHEMACreatechange
JSON SCHEMACreateChannel
JSON SCHEMACreateDocumentResponse
JSON SCHEMACreateEditSessionRequest
JSON SCHEMACreateEditSessionResponse
JSON SCHEMACreateevidenceRequest
JSON SCHEMACreateFeedRequest
JSON SCHEMACreateGiftCardCancellationTransactionRequest
JSON SCHEMACreateGiftCardinGiftCardProviderRequest
JSON SCHEMACreateGiftCardRequest
JSON SCHEMACreateGiftCardSettlementTransactionRequest
JSON SCHEMACreateGiftCardTransactionCancellationRequest
JSON SCHEMACreateGiftCardTransactionRequest
JSON SCHEMACreateGiftCardTransactionSettlementRequest
JSON SCHEMACreateInteractionRequest
JSON SCHEMACreatelabelsRequest
JSON SCHEMACreateLogRequest
JSON SCHEMACreatenewappkeyRequest
JSON SCHEMACreatenewappkeyResponse
JSON SCHEMACreatenotesRequest
JSON SCHEMACreateReservationRequest
JSON SCHEMACreateSellerRequest
JSON SCHEMACreateServiceBody
JSON SCHEMACreatetokenRequest
JSON SCHEMACreate/Update
JSON SCHEMACreate/UpdateCarrier(DeliveryWindows)Request
JSON SCHEMACreate/UpdateCarrierRequest
JSON SCHEMACreate/UpdateDockRequest
JSON SCHEMACreate/UpdateFreightValuesRequest
JSON SCHEMACreateUpdateGiftCardProviderbyIDRequest
JSON SCHEMACreate/UpdateHolidayRequest
JSON SCHEMACreate/UpdatePolygonRequest
JSON SCHEMACreate/UpdateRequest
JSON SCHEMACreate/UpdateWarehouseRequest
JSON SCHEMACreateUserRequest
JSON SCHEMAcredentials
JSON SCHEMACurrencyCode
JSON SCHEMACurrencyCode1
JSON SCHEMACurrencyFormatInfo
JSON SCHEMACustomApp
JSON SCHEMACustomData
JSON SCHEMAData
JSON SCHEMAData1
JSON SCHEMAData12
JSON SCHEMAData15
JSON SCHEMAData18
JSON SCHEMAData3
JSON SCHEMAData9
JSON SCHEMADateRange
JSON SCHEMADayOfWeekForDelivery
JSON SCHEMADayOfWeekForDelivery1
JSON SCHEMADeliverybyfranchiseseller
JSON SCHEMADeliverybyseller
JSON SCHEMADeliveryChannel
JSON SCHEMADeliveryId
JSON SCHEMADeliveryIds
JSON SCHEMADeliveryIdV2
JSON SCHEMADeliveryItemOption
JSON SCHEMADeliveryRange
JSON SCHEMADeliveryRange1
JSON SCHEMADeliveryReasonResponse
JSON SCHEMADeliveryService
JSON SCHEMADelivery Service Object
JSON SCHEMADelivery Service Response body _v1_1
JSON SCHEMADeliveryServiceRoute
JSON SCHEMADeliveryServiceRouteItemResponse
JSON SCHEMADeliveryServiceRouteItemStatusResponse
JSON SCHEMADeliveryServiceRouteResponse
JSON SCHEMADeliveryServiceRouteStatusResponse
JSON SCHEMADeliveryServiceStatusResponse
JSON SCHEMADeliveryServiceTypeResponse
JSON SCHEMADeliverySlaPerType
JSON SCHEMADeliverySlaPerType2
JSON SCHEMADeliverySlaSample
JSON SCHEMADeliveryWindow
JSON SCHEMADepartment
JSON SCHEMADetails
JSON SCHEMADimension
JSON SCHEMADimension1
JSON SCHEMADimensions
JSON SCHEMADispatchOrder
JSON SCHEMADisplacementTypeResponse
JSON SCHEMADocument
JSON SCHEMADocumentRequest
JSON SCHEMAdocumentResponse
JSON SCHEMAEditTaskRequest
JSON SCHEMAEnqueueNewOrderRequest
JSON SCHEMAError
JSON SCHEMAErrorbytoomanyactivereservations
JSON SCHEMAErrors
JSON SCHEMAEvaluatePolicyRequest
JSON SCHEMAEvent
JSON SCHEMAEvidence
JSON SCHEMAExample
JSON SCHEMAExample2
JSON SCHEMAExample3
JSON SCHEMAFacets
JSON SCHEMAFacets1
JSON SCHEMAFail-BadRequest
JSON SCHEMAFail-GenericError1
JSON SCHEMAFail-GenericError2
JSON SCHEMAFail-GenericError3
JSON SCHEMAFeedConfigurationRequest
JSON SCHEMAFilter
JSON SCHEMAField
JSON SCHEMAFields
JSON SCHEMAFields1
JSON SCHEMAFields3
JSON SCHEMAfile-data
JSON SCHEMAFixedPrice
JSON SCHEMAFollower
JSON SCHEMAFreightPriceResponse
JSON SCHEMAFrequency
JSON SCHEMAFrequencyRequest
JSON SCHEMAFrequency
JSON SCHEMAFrom
JSON SCHEMAFrom1
JSON SCHEMAFrom2
JSON SCHEMAFromV2
JSON SCHEMAFulfillment
JSON SCHEMAFulfillment1
JSON SCHEMAfulfillmentItem
JSON SCHEMAgeneratedObject
JSON SCHEMAGeoCoordinates
JSON SCHEMAGeoShape
JSON SCHEMAGetAntifraudStatus
JSON SCHEMAGetappkeysfromaccount
JSON SCHEMAGetById
JSON SCHEMAGetCategoryTree
JSON SCHEMAGetCategoryTreeChild
JSON SCHEMAGetChangeDetail
JSON SCHEMAGetChangeHistory
JSON SCHEMAGetcomputedprice
JSON SCHEMAGetConversation
JSON SCHEMAgetcoupons
JSON SCHEMAGetfeedorderstatus
JSON SCHEMAGetGiftCardfromGiftCardProviderRequest
JSON SCHEMAGetGiftCardusingJSONRequest
JSON SCHEMAGetOrder
JSON SCHEMAGetorUpdateProductSpecification
JSON SCHEMAGetPaymentMethodsSupported
JSON SCHEMAGetPaymenttransaction
JSON SCHEMAGetprice
JSON SCHEMAGetPricesRequestObject
JSON SCHEMAGetRulesResponse
JSON SCHEMAGetSchemasResponse
JSON SCHEMAGetSessionResponse
JSON SCHEMAGetSKUAltID
JSON SCHEMAGetSKUandContext
JSON SCHEMAGetSpecFieldValue
JSON SCHEMAGetversion
JSON SCHEMAGiftCardTransactionRequest
JSON SCHEMAGiftCardTransactionResponse
JSON SCHEMAgroups
JSON SCHEMAHeaders
JSON SCHEMAHook
JSON SCHEMAHookConfiguration
JSON SCHEMAHookConfigurationRequest
JSON SCHEMAFilter
JSON SCHEMAImage
JSON SCHEMAImages
JSON SCHEMAimportResult
JSON SCHEMAInboundRequest_BETA_Request
JSON SCHEMAIndex
JSON SCHEMAInsertAffiliationRequest
JSON SCHEMAInsertRuleRequest
JSON SCHEMAInstallment
JSON SCHEMAInStore
JSON SCHEMAInStore1
JSON SCHEMAInsurancePrice
JSON SCHEMAInteractions
JSON SCHEMAInvalidRequestValue
JSON SCHEMAInvoiceData
JSON SCHEMARequest body
JSON SCHEMAInvoiceNotificationRequest
JSON SCHEMAIssuer
JSON SCHEMAItem
JSON SCHEMAItem1
JSON SCHEMAItem1V2
JSON SCHEMAItem2
JSON SCHEMAItem2V2
JSON SCHEMAItem3
JSON SCHEMAItem4
JSON SCHEMAitemAttachment
JSON SCHEMAitems
JSON SCHEMAItemSimulationStatus
JSON SCHEMAItemsRemoved
JSON SCHEMAItemsReturned
JSON SCHEMAItemV2
JSON SCHEMAKitItem
JSON SCHEMALabel
JSON SCHEMALegalTypeResponse
JSON SCHEMALicenseItems
JSON SCHEMAList
JSON SCHEMAList1
JSON SCHEMAListAllGiftCardsRequest
JSON SCHEMAListOrders
JSON SCHEMAListRegistry
JSON SCHEMAListRequest
JSON SCHEMAListRolesResponse
JSON SCHEMAListUsersResponse
JSON SCHEMAListversion
JSON SCHEMALocation
JSON SCHEMALocation1
JSON SCHEMALocation3
JSON SCHEMALocation5
JSON SCHEMALogisticsInfo
JSON SCHEMALogisticsInfo1
JSON SCHEMALogisticsInfo2
JSON SCHEMALogisticsInfoDeliveryWindow
JSON SCHEMALogisticsInfoSLA
JSON SCHEMALogisticsInfoV2
JSON SCHEMAm4031
JSON SCHEMAm4041
JSON SCHEMAMainImage
JSON SCHEMAMarketplace
JSON SCHEMAMarketplace1
JSON SCHEMAMarketplace2
JSON SCHEMAMasked address response
JSON SCHEMAMasked profile response
JSON SCHEMAMasked profile response
JSON SCHEMAMasked prospect information.
JSON SCHEMAMasked purchase information response.
JSON SCHEMAMatcher
JSON SCHEMAMatchMultiple
JSON SCHEMAMaxDimension
JSON SCHEMAMaxDimension1
JSON SCHEMAMaxDimension2
JSON SCHEMAMetaData
JSON SCHEMAMetaData1
JSON SCHEMAMiniCart
JSON SCHEMAName
JSON SCHEMANewNoteRequest
JSON SCHEMANewTaskRequest
JSON SCHEMANonDeliveryReasonResponse
JSON SCHEMANote
JSON SCHEMANotifyCarrierwithAppRequest
JSON SCHEMAOffer
JSON SCHEMAOffersPerSalesChannel
JSON SCHEMAOnholdserviceRequest
JSON SCHEMAOption
JSON SCHEMAVTEX Order
JSON SCHEMAorderForm
JSON SCHEMAOrderFormSimulationRequest
JSON SCHEMAOrderInfo
JSON SCHEMAOrderItem
JSON SCHEMAorderPlacement
JSON SCHEMAOrderProduct
JSON SCHEMAOrigin
JSON SCHEMAOrigin1
JSON SCHEMAOrigin2
JSON SCHEMAOriginV2
JSON SCHEMAPackage
JSON SCHEMAPackageAttachment
JSON SCHEMAPageCart
JSON SCHEMAPage Confirmation
JSON SCHEMAEmpty Cart
JSON SCHEMAPaging
JSON SCHEMAPartial update connector
JSON SCHEMAPauseResumeServiceRequest
JSON SCHEMAPauseResumeServiceResponse
JSON SCHEMAPayment
JSON SCHEMAPayment1
JSON SCHEMAPaymentConfiguration
JSON SCHEMAPaymentData
JSON SCHEMAPaymentDataV2
JSON SCHEMAPaymentDetailsResponse
JSON SCHEMAPaymentField
JSON SCHEMAPaymentMethod
JSON SCHEMAPaymentMethodRequest
JSON SCHEMAPayments
JSON SCHEMAPaymentSystem
JSON SCHEMAPaymentSystemsResponse
JSON SCHEMAPeriodicity
JSON SCHEMAPickupStoreInfo
JSON SCHEMAPickupStoreInfo1
JSON SCHEMAPickupStoreInfoV2
JSON SCHEMAPlan
JSON SCHEMAPlanRequest
JSON SCHEMAPolicyActionGetResponse
JSON SCHEMAPolicyGetResponse
JSON SCHEMAPolicySaveRequest
JSON SCHEMAPostWithRoute
JSON SCHEMAPreviewChange
JSON SCHEMAPreviewChange1
JSON SCHEMAPriceChangeRequest
JSON SCHEMAPriceDefinition
JSON SCHEMAPriceTag
JSON SCHEMAPricingConfiguration
JSON SCHEMAVTEX Product
JSON SCHEMAProductItems
JSON SCHEMAProductSearch
JSON SCHEMAProductSpecification
JSON SCHEMAProfile
JSON SCHEMAid
JSON SCHEMAProfile metadata
JSON SCHEMAProperties
JSON SCHEMAProspect information.
JSON SCHEMAid
JSON SCHEMAProspect information metadata.
JSON SCHEMAPurchaseContextAvailableGiftResponse
JSON SCHEMAPurchaseContextSelectableGiftsResponse
JSON SCHEMAPurchaseDay
JSON SCHEMAPurchase information.
JSON SCHEMAid
JSON SCHEMAPurchase information metadata.
JSON SCHEMAPurchaseSettings
JSON SCHEMAPurchaseSettingsRequest
JSON SCHEMAPutindicesRequest
JSON SCHEMAPutselleraccountconfigRequest
JSON SCHEMASearch Query
JSON SCHEMAQueue
JSON SCHEMARate
JSON SCHEMARate1
JSON SCHEMARatesAndBenefitsData
JSON SCHEMARealDimension
JSON SCHEMAReceipt
JSON SCHEMAReferenceId
JSON SCHEMARefundPayment
JSON SCHEMARefunds
JSON SCHEMARefundthetransactionRequest
JSON SCHEMARegion
JSON SCHEMARegion2
JSON SCHEMARegisterChange
JSON SCHEMARegisterChangeRequest
JSON SCHEMAReplace
JSON SCHEMAReplace1
JSON SCHEMAReplace2
JSON SCHEMAReportResponse
JSON SCHEMArepsonseOrderId
JSON SCHEMARequest
JSON SCHEMArequestCancelOrderMarketplace
JSON SCHEMARequestData
JSON SCHEMArequestFulfillmentSimulation
JSON SCHEMArequestOrderId
JSON SCHEMArequestSendInvoice
JSON SCHEMArequestSendTracking
JSON SCHEMArequestUpdateTrackingStatus
JSON SCHEMAResoluO
JSON SCHEMAresponse
JSON SCHEMAresponse1
JSON SCHEMAresponse2
JSON SCHEMAresponse202
JSON SCHEMAresponse3
JSON SCHEMAresponse5
JSON SCHEMAresponse6
JSON SCHEMAresponse7
JSON SCHEMAresponseCreateSellerLead
JSON SCHEMAResponseData
JSON SCHEMAresponseFulfill
JSON SCHEMAResponse body
JSON SCHEMAGetAccountsMatcherSettings
JSON SCHEMAresponseGetMatchedOffersDataByProductId
JSON SCHEMAresponseGetMatchedOffersDataBySKU
JSON SCHEMAresponseGetMatchedOffersList
JSON SCHEMAGetSellersApprovalSettings
JSON SCHEMAresponseMatchMultiple
JSON SCHEMAresponseOrderPlacement
JSON SCHEMAResponses
JSON SCHEMAresponseSellerCommissionsID
JSON SCHEMAResponseService
JSON SCHEMARoleItems
JSON SCHEMARulesRequest
JSON SCHEMASalesChannel
JSON SCHEMASaveaccountconfigRequest
JSON SCHEMASaveautoapproveforaccountRequest
JSON SCHEMASaveautoapproveforaccountsellerRequest
JSON SCHEMASaveMultipleReviewsRequest
JSON SCHEMASaveReviewRequest
JSON SCHEMASaveschemabynameRequest
JSON SCHEMASaveSuggestionRequest
JSON SCHEMAScheduling
JSON SCHEMASchema
JSON SCHEMAScore
JSON SCHEMASearchSuggestions
JSON SCHEMAsecuritySchemes
JSON SCHEMASegment
JSON SCHEMASelectedAddress
JSON SCHEMASelf
JSON SCHEMASeller
JSON SCHEMASeller Commission Configuration
JSON SCHEMASellingPrice
JSON SCHEMASendAntifraudData
JSON SCHEMASendAntifraudDataRequest
JSON SCHEMAsendCategoryMappingToVtexMapper
JSON SCHEMASender
JSON SCHEMAServiceBody
JSON SCHEMAServiceBody1
JSON SCHEMAServiceBody3
JSON SCHEMAServiceBody4
JSON SCHEMAServiceBody5
JSON SCHEMAServiceBody6
JSON SCHEMASessionPing
JSON SCHEMASetsinglecustomfieldvalueRequest
JSON SCHEMASettings
JSON SCHEMASettlement
JSON SCHEMASettlements
JSON SCHEMASettlePayment
JSON SCHEMASettleResponse
JSON SCHEMASettlethetransactionRequest
JSON SCHEMAShipperBranchResponse
JSON SCHEMAShipperCustomer
JSON SCHEMAShipperCustomerResponse
JSON SCHEMAShipperPartnerResponse
JSON SCHEMAShipperResponse
JSON SCHEMAShipperTypeResponse
JSON SCHEMAShipping
JSON SCHEMAshippingAddress
JSON SCHEMAAddress
JSON SCHEMAShippingCompanyResponse
JSON SCHEMAShippingData
JSON SCHEMAShippingData1
JSON SCHEMAShippingData2
JSON SCHEMAShippingData3
JSON SCHEMAShippingDataV2
JSON SCHEMAShippingEstimate
JSON SCHEMAShippingPrice
JSON SCHEMAShippingPrice1
JSON SCHEMASimulateMessageResponse
JSON SCHEMASimulateResponse
JSON SCHEMASimulateResponseVO
JSON SCHEMASimulationItemResult
JSON SCHEMASiteItems
JSON SCHEMASKU
JSON SCHEMASku
JSON SCHEMASkuComplement
JSON SCHEMASKUFile
JSON SCHEMASKUFileURL
JSON SCHEMASkuKit
JSON SCHEMASkulistbyProductId
JSON SCHEMASkuSeller
JSON SCHEMASKUService
JSON SCHEMASKUServiceTypeRequest
JSON SCHEMASKUServiceTypeResponse
JSON SCHEMASKUServiceValueRequest
JSON SCHEMASKUServiceValueResponse
JSON SCHEMASkuSpecification
JSON SCHEMASKUSpecificationResponse
JSON SCHEMASla
JSON SCHEMASlaRequest
JSON SCHEMASlaV2
JSON SCHEMASpecificationFilters
JSON SCHEMASpecificationGroupInsertRequest
JSON SCHEMASpecifications
JSON SCHEMASpecificationsGroup
JSON SCHEMASpecificationsInsertFieldRequest
JSON SCHEMASpecificationsInsertFieldUpdateRequest
JSON SCHEMASpecificationsInsertFieldValueRequest
JSON SCHEMASpecificationsUpdateFieldValueRequest
JSON SCHEMAStartTransactionResponse
JSON SCHEMAStatementGetResponse
JSON SCHEMAStateResponse
JSON SCHEMAStats
JSON SCHEMAStats1
JSON SCHEMAStats2
JSON SCHEMAStats3
JSON SCHEMAStatus
JSON SCHEMAStoreItems
JSON SCHEMAStorePlan
JSON SCHEMAStorePreferencesData
JSON SCHEMAState
JSON SCHEMACity
JSON SCHEMANeighborhood
JSON SCHEMASubscriptionCycleContext
JSON SCHEMASubscriptionCycleItemContext
JSON SCHEMASubscriptionCycleOrderInfo
JSON SCHEMASubscriptionCycleResponse
JSON SCHEMASubscriptionRequest
JSON SCHEMASubscription
JSON SCHEMASubscriptionItem
JSON SCHEMASubscriptionReport
JSON SCHEMASubscriptionReportParam
JSON SCHEMASubscriptionThinItemRequest
JSON SCHEMASubscriptionUpdateRequest
JSON SCHEMASuccess-Approved
JSON SCHEMASuccess-Manifest
JSON SCHEMASuccess
JSON SCHEMASuccess1
JSON SCHEMASuccess2
JSON SCHEMASuccess3
JSON SCHEMASuccess4
JSON SCHEMASuccess5
JSON SCHEMASuccess6
JSON SCHEMASupplierRequest
JSON SCHEMASupplierResponse
JSON SCHEMATamanhoDaTela
JSON SCHEMATarget
JSON SCHEMATestJSONataExpression
JSON SCHEMATimeline
JSON SCHEMATimezone
JSON SCHEMATo
JSON SCHEMATo1
JSON SCHEMATo2
JSON SCHEMATokenResponse
JSON SCHEMATopSearches
JSON SCHEMATotal
JSON SCHEMATotalItems
JSON SCHEMATotalItems1
JSON SCHEMATotalization
JSON SCHEMATotalizationResponse
JSON SCHEMATotalV2
JSON SCHEMATotalValue
JSON SCHEMATotalValue1
JSON SCHEMAToV2
JSON SCHEMATrackingEventsRequest
JSON SCHEMATransaction
JSON SCHEMATransactionDetailsResponse
JSON SCHEMATransactionInteractionsResponse
JSON SCHEMATransactionResponse
JSON SCHEMATransactions
JSON SCHEMATransactionSettlementDetails
JSON SCHEMAType
JSON SCHEMAUnmasked address response
JSON SCHEMAUnmasked profile response
JSON SCHEMAUnmasked prospect information.
JSON SCHEMAUpdateAffiliationRequest
JSON SCHEMAUpdateAntifraudTransactionsoptionalRequest
JSON SCHEMAUpdateappkeyRequest
JSON SCHEMAUpdateFeedRequest
JSON SCHEMAUpdateInventoryBySkuandWarehouseRequest
JSON SCHEMAUpdateItemInput
JSON SCHEMAUpdateorderFormconfigurationRequest
JSON SCHEMAUpdateOrderStatusRequest
JSON SCHEMAUpdatepartialinvoice.SendTrackingNumber
JSON SCHEMAUpdateSellerRequest
JSON SCHEMAUpdateserviceRequest
JSON SCHEMAUpdateTrackingStatus
JSON SCHEMAUpdateTrackingStatusRequest
JSON SCHEMAUpsertMappingRequest
JSON SCHEMAUpsert merchant connection
JSON SCHEMAConfigure Seller Account
JSON SCHEMAUserIdentification
JSON SCHEMAUserItems
JSON SCHEMAUserorderdetails
JSON SCHEMAUserorderslist
JSON SCHEMAUserPaymentInfo
JSON SCHEMAUsing_fields=_all
JSON SCHEMAvalidationResult
JSON SCHEMAValidator
JSON SCHEMAValidityRequest
JSON SCHEMAValidity
JSON SCHEMAValidRequest
JSON SCHEMAVehicle
JSON SCHEMAVehicleTypeResponse
JSON SCHEMAVLMError
JSON SCHEMAVtexMapperRegistration
JSON SCHEMAWaitingTime
JSON SCHEMAWarehouseDock
JSON SCHEMAWarehouseDock1
JSON SCHEMAScroll within the panel for all 655 ·
JSON Structure 2
JSON Structure captures the data shapes in a form built for tooling — a complement to JSON Schema that keeps the model machine-legible.
JSON Structure definitions describing this provider's data shapes.
Vtex Order Structure
JSON STRUCTUREVtex Structure
JSON STRUCTUREExamples 457
Real request and response payloads are what turn a spec from abstract into obvious — and they're one of the twelve things an agent needs to call an API correctly on the first try.
Example request and response payloads for these APIs.
Vtex 1Retrievetoken Example
EXAMPLEVtex 4Getcredentials Example
EXAMPLEVtex Addcomment Example
EXAMPLEVtex Addcoupons Example
EXAMPLEVtex Addlog Example
EXAMPLEVtex Addpaymentdata Example
EXAMPLEVtex Affiliationbyid Example
EXAMPLEVtex Affiliations Example
EXAMPLEVtex Alldocks Example
EXAMPLEVtex Allwarehouses Example
EXAMPLEVtex Autocomplete Example
EXAMPLEVtex Brand Example
EXAMPLEVtex Brandlist Example
EXAMPLEVtex Calculatesla Example
EXAMPLEVtex Cancelorder Example
EXAMPLEVtex Cancelpayment Example
EXAMPLEVtex Cartsimulation Example
EXAMPLEVtex Categorytree Example
EXAMPLEVtex Checkprogress Example
EXAMPLEVtex Closeanaccount Example
EXAMPLEVtex Create Product Example
EXAMPLEVtex Createanewcart Example
EXAMPLEVtex Createcategory Example
EXAMPLEVtex Createchange Example
EXAMPLEVtex Createchannel Example
EXAMPLEVtex Createdkim Example
EXAMPLEVtex Createevidence Example
EXAMPLEVtex Createfeed Example
EXAMPLEVtex Creategiftcard Example
EXAMPLEVtex Createlabels Example
EXAMPLEVtex Createlog Example
EXAMPLEVtex Createnewappkey Example
EXAMPLEVtex Createnotes Example
EXAMPLEVtex Createpayment Example
EXAMPLEVtex Createprospect Example
EXAMPLEVtex Createseller Example
EXAMPLEVtex Createservice Example
EXAMPLEVtex Createtoken Example
EXAMPLEVtex Createuser Example
EXAMPLEVtex Deletereview Example
EXAMPLEVtex Dockbyid Example
EXAMPLEVtex Editreview Example
EXAMPLEVtex Editsession Example
EXAMPLEVtex Edittask Example
EXAMPLEVtex Enqueueneworder Example
EXAMPLEVtex Facetscategory Example
EXAMPLEVtex Freightvalues Example
EXAMPLEVtex Getaccount Example
EXAMPLEVtex Getbrand Example
EXAMPLEVtex Getbyaccount Example
EXAMPLEVtex Getbyid Example
EXAMPLEVtex Getcategorytree Example
EXAMPLEVtex Getchangedetail Example
EXAMPLEVtex Getcmspage Example
EXAMPLEVtex Getconversation Example
EXAMPLEVtex Getcredentials Example
EXAMPLEVtex Getdocument Example
EXAMPLEVtex Getfixedprices Example
EXAMPLEVtex Getgiftcardbyid Example
EXAMPLEVtex Getindexbyname Example
EXAMPLEVtex Getindices Example
EXAMPLEVtex Getlistroles Example
EXAMPLEVtex Getlistusers Example
EXAMPLEVtex Getmatchconfig Example
EXAMPLEVtex Getnote Example
EXAMPLEVtex Getofferslist Example
EXAMPLEVtex Getorder Example
EXAMPLEVtex Getorder2 Example
EXAMPLEVtex Getprice Example
EXAMPLEVtex Getproduct Example
EXAMPLEVtex Getproductbyid Example
EXAMPLEVtex Getproductquery Example
EXAMPLEVtex Getprofile Example
EXAMPLEVtex Getprospect Example
EXAMPLEVtex Getprospects Example
EXAMPLEVtex Getrolesbyuser Example
EXAMPLEVtex Getschemabyname Example
EXAMPLEVtex Getschemas Example
EXAMPLEVtex Getsegment Example
EXAMPLEVtex Getservice Example
EXAMPLEVtex Getsession Example
EXAMPLEVtex Getskuoffers Example
EXAMPLEVtex Getskuseller Example
EXAMPLEVtex Gettask Example
EXAMPLEVtex Getuser Example
EXAMPLEVtex Getversion Example
EXAMPLEVtex Insertrule Example
EXAMPLEVtex Inventorybysku Example
EXAMPLEVtex Items Example
EXAMPLEVtex Itemshandle Example
EXAMPLEVtex Itemsupdate Example
EXAMPLEVtex List Orders Example
EXAMPLEVtex Listallskuids Example
EXAMPLEVtex Listbrand Example
EXAMPLEVtex Listfeeds Example
EXAMPLEVtex Listorders Example
EXAMPLEVtex Listorders2 Example
EXAMPLEVtex Listpricetables Example
EXAMPLEVtex Listsku Example
EXAMPLEVtex Listversions Example
EXAMPLEVtex Manifest Example
EXAMPLEVtex Match Example
EXAMPLEVtex Newnote Example
EXAMPLEVtex Newtask Example
EXAMPLEVtex Onholdservice Example
EXAMPLEVtex Openanaccount Example
EXAMPLEVtex Order Placement Example
EXAMPLEVtex Paymentdetails Example
EXAMPLEVtex Placeorder Example
EXAMPLEVtex Policy Evaluate Example
EXAMPLEVtex Policy Get Example
EXAMPLEVtex Policy List Example
EXAMPLEVtex Post Event Example
EXAMPLEVtex Postbrand Example
EXAMPLEVtex Postproduct Example
EXAMPLEVtex Previewchange Example
EXAMPLEVtex Pricechange Example
EXAMPLEVtex Processorder Example
EXAMPLEVtex Productbyrefid Example
EXAMPLEVtex Productsearch Example
EXAMPLEVtex Putbrand Example
EXAMPLEVtex Putindices Example
EXAMPLEVtex Putrolesinuser Example
EXAMPLEVtex Putrulebyid Example
EXAMPLEVtex Putversion Example
EXAMPLEVtex Refundpayment Example
EXAMPLEVtex Registerchange Example
EXAMPLEVtex Removeallitems Example
EXAMPLEVtex Reservationbyid Example
EXAMPLEVtex Retrychange Example
EXAMPLEVtex Rulebyid Example
EXAMPLEVtex Rules Example
EXAMPLEVtex Savereview Example
EXAMPLEVtex Savesuggestion Example
EXAMPLEVtex Savesupplylot Example
EXAMPLEVtex Scrolldocuments Example
EXAMPLEVtex Searchdocuments Example
EXAMPLEVtex Searchsku Example
EXAMPLEVtex Send Invoice Example
EXAMPLEVtex Settlepayment Example
EXAMPLEVtex Sku Example
EXAMPLEVtex Skubyean Example
EXAMPLEVtex Skucontext Example
EXAMPLEVtex Skuidbyrefid Example
EXAMPLEVtex Starthandling Example
EXAMPLEVtex Trackingevents Example
EXAMPLEVtex Updateappkey Example
EXAMPLEVtex Updatefeed Example
EXAMPLEVtex Updateprospect Example
EXAMPLEVtex Updateservice Example
EXAMPLEVtex Uploadfile Example
EXAMPLEVtex Upsertmapping Example
EXAMPLEVtex Userorderslist Example
EXAMPLEVtex Warehousebyid Example
EXAMPLEScroll within the panel for all 457 ·
Security Posture 3
Authentication, domain security, vulnerability disclosure, and trust-center signals — the evidence that a provider takes security seriously enough to document it. We profile it because you can't govern what you can't see.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
Agentic Access 1
An x-agentic-access contract marks which operations are safe for an agent to run on its own and which need a human in the loop. It is the difference between an API an agent can use and one it can use safely.
Recommended x-agentic-access execution contracts for AI agents.
Resources
Every other property we hold for VTEX — documentation, portals, status pages, policies, and corporate surface — grouped by the job it does, following the integrator's arc from getting started to running in production.
Get Started 1
Portal, sign-up, and the first successful call
Documentation 1
Reference material describing how the API behaves
Agent Surfaces 1
MCP servers, agent skills, and machine-readable catalogs
Design & Contract 3
Pagination, idempotency, versioning, errors, and events
Build 2
SDKs, sample code, and the tooling you integrate with
Access & Security 3
Authentication, authorization, and security posture
Operate 5
Status, limits, changes, and where to get help
Company 3
The organization behind the API
← All providers · Data indexed from github.com/api-evangelist/vtex · machine-readable index on apis.io