> Check the new [Catalog onboarding guide](https://developers.vtex.com/docs/guides/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'
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://vtex.local https://{accountName}.{environment}.com.br https://{accountName}.{environment}.com.br/api/rns
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
> Check the new [Catalog onboarding guide](https://developers.vtex.com/docs/guides/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. Methods for collecting product/SKU catalog data, categories, brands and other informat
| method | path | what the vendor says it does |
|---|---|---|
GET | /api/addon/pvt/giftlist/get/{listId} | Get Gift List Retrieves information about a Gift List by its ID. Gift List |
GET | /api/addon/pvt/review/GetProductRate/{productId} | Get Product Review Rate by Product ID Retrieves the review rate of a product by this product's ID. Product |
POST | /api/catalog/pvt/attachment | Create attachment Creates a new SKU attachment. >⚠️ To understand the specific syntax for Assembly Options a |
GET | /api/catalog/pvt/attachment/{attachmentid} | Get attachment Gets information about a registered attachment. >⚠️ To understand the specific syntax for As |
PUT | /api/catalog/pvt/attachment/{attachmentid} | Update attachment Updates a previously existing SKU attachment with new information. >⚠️ To understand the |
DELETE | /api/catalog/pvt/attachment/{attachmentid} | Delete attachment Deletes a previously existing SKU attachment. Attachment |
GET | /api/catalog/pvt/attachments | Get all attachments Retrieves information about all registered attachments. >⚠️ To understand the specific |
POST | /api/catalog/pvt/brand | Create Brand Creates a new Brand. ## Request and response body example ```json { "Id": 2000013, "Na |
GET | /api/catalog/pvt/brand/{brandId} | Get Brand and context Retrieves information about a specific Brand and its context. ## Response body example |
PUT | /api/catalog/pvt/brand/{brandId} | Update Brand Updates a previously existing Brand. ## Request and response body example ```json { "Id": |
DELETE | /api/catalog/pvt/brand/{brandId} | Delete Brand Deletes an existing Brand. Brand |
POST | /api/catalog/pvt/category | Create Category Creates a new Category. If there is a need to create a new category with a specific custom |
GET | /api/catalog/pvt/category/{categoryId} | Get Category by ID Retrieves general information about a Category. ## Response body example ```json { |
PUT | /api/catalog/pvt/category/{categoryId} | Update Category Updates a previously existing Category. ## Request body example ```json { "Name": |
POST | /api/catalog/pvt/collection | Create Collection >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta |
POST | /api/catalog/pvt/collection/ | Create Collection Creates a new collection. Collection Beta |
GET | /api/catalog/pvt/collection/inactive | Get All Inactive Collections Retrieves a list of Collection IDs of the inactive Collections. Collection Beta |
GET | /api/catalog/pvt/collection/stockkeepingunit/importfileexample | Import Collection file example Imports a sample of the imported XLS file. You need to save the response file t |
GET | /api/catalog/pvt/collection/{collectionId} | Get Collection >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Co |
PUT | /api/catalog/pvt/collection/{collectionId} | Update Collection >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta |
DELETE | /api/catalog/pvt/collection/{collectionId} | Delete Collection >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta |
POST | /api/catalog/pvt/collection/{collectionId}/position | Reposition SKU on the Subcollection >⚠️ There are two ways to configure collections, through Legacy CMS Portal |
GET | /api/catalog/pvt/collection/{collectionId}/products | Get products from a collection Retrieves information about the products from a collection. Collection Beta |
POST | /api/catalog/pvt/collection/{collectionId}/stockkeepingunit/importexclude | Remove products from Collection by imported file Removes products from a collection from the request body file |
POST | /api/catalog/pvt/collection/{collectionId}/stockkeepingunit/importinsert | Add products to Collection by imported file Adds products to a collection from the request body file. The file |
GET | /api/catalog/pvt/collection/{collectionId}/subcollection | Get Subcollection by Collection ID >⚠️ There are two ways to configure collections, through Legacy CMS Portal |
POST | /api/catalog/pvt/product | Create Product with Category and Brand This endpoint allows two types of request: **Type 1:** Creating a ne |
GET | /api/catalog/pvt/product/{productId} | Get Product by ID Retrieves a specific Product by its ID. This information is exactly what is needed to create |
PUT | /api/catalog/pvt/product/{productId} | Update Product Updates an existing Product. Product |
GET | /api/catalog/pvt/product/{productId}/salespolicy | Get Trade Policies by Product ID Retrieves a list of Trade Policies associated to a Product based on the Produ |
POST | /api/catalog/pvt/product/{productId}/salespolicy/{tradepolicyId} | Associate Product with Trade Policy Associates an existing Trade Policy with a Product. Trade Policy |
DELETE | /api/catalog/pvt/product/{productId}/salespolicy/{tradepolicyId} | Remove Product from Trade Policy Disassociates a Trade Policy of a Product. Trade Policy |
GET | /api/catalog/pvt/product/{productId}/similarcategory/ | Get Similar Categories Retrieves Similar Categories from a Product. ## Response body example ```json [ |
POST | /api/catalog/pvt/product/{productId}/similarcategory/{categoryId} | Add Similar Category Adds a Similar Category to a Product. ## Response body example ```json { "Pro |
DELETE | /api/catalog/pvt/product/{productId}/similarcategory/{categoryId} | Delete Similar Category Deletes a Similar Category from a Product. Similar Category |
GET | /api/catalog/pvt/product/{productId}/specification | Get Product Specification and its information by Product ID Retrieves information of all specifications of a p |
POST | /api/catalog/pvt/product/{productId}/specification | Associate Product Specification Associates a previously defined Specification to a Product. ### Request bod |
DELETE | /api/catalog/pvt/product/{productId}/specification | Delete all Product Specifications by Product ID Deletes all Product Specifications given a specific Product ID |
DELETE | /api/catalog/pvt/product/{productId}/specification/{specificationId} | Delete a specific Product Specification Deletes a specific Product Specification given a Product ID and a Spec |
PUT | /api/catalog/pvt/product/{productId}/specificationvalue | Associate product specification using specification name and group name Associates a specification to a produc |
and 122 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Catalog API.json
>Check the [Fulfillment onboarding guide](https://developers.vtex.com/docs/guides/fulfillment). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about fulfillment and is organized by focusing on the developer's journey. Logistics or fulfillment is the module responsible for shipping calculation and inventor
| method | path | what the vendor says it does |
|---|---|---|
GET | /api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames | Search capacity reservations in time range Get information on all capacity reservations made to scheduled deli |
GET | /api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames/{windowDay}F{windowStartTime}T{windowEndTime} | Get capacity reservation usage by window Retrieves capacity usage of a specific scheduled delivery reservation |
POST | /api/logistics/pvt/configuration/carriers/{carrierId}/adddayofweekblocked | Add blocked delivery windows Adds blocked delivery windows for your store's shipping policies. > Note that, |
GET | /api/logistics/pvt/configuration/carriers/{carrierId}/getdayofweekblocked | Retrieve blocked delivery windows Lists all blocked delivery windows of your store's shipping policies, search |
POST | /api/logistics/pvt/configuration/carriers/{carrierId}/removedayofweekblocked | Remove blocked delivery windows Removes the blocked delivery windows set to your store's shipping policies. |
GET | /api/logistics/pvt/configuration/docks | List all docks Informs a list of all docks. Docks |
POST | /api/logistics/pvt/configuration/docks | Create/update dock Creates or updates docks to be used in your logistic operation. Docks |
GET | /api/logistics/pvt/configuration/docks/{dockId} | List dock by ID Informs a given dock's information, searching by dock ID. Docks |
DELETE | /api/logistics/pvt/configuration/docks/{dockId} | Delete dock Deletes dock by dock ID. Docks |
POST | /api/logistics/pvt/configuration/docks/{dockId}/activation | Activate dock Activates dock through dock ID. Docks |
POST | /api/logistics/pvt/configuration/docks/{dockId}/deactivation | Deactivate dock Deactivate dock by dock ID Docks |
POST | /api/logistics/pvt/configuration/freights/{carrierId}/values/update | Create/update freight values Creates or updates the freight values of your store's carriers. Learn more in [Sh |
GET | /api/logistics/pvt/configuration/freights/{carrierId}/{cep}/values | List freight values Lists freight values apointed to your store's carriers, searching by carrier ID and postal |
GET | /api/logistics/pvt/configuration/geoshape | List paged polygons Lists stored polygons. Polygons |
PUT | /api/logistics/pvt/configuration/geoshape | Create/update polygon Creates or updates your store's polygons by geoshape coordinates and polygon name. Polyg |
GET | /api/logistics/pvt/configuration/geoshape/{polygonName} | List polygon by ID Lists your store's polygons by searching through polygon name Polygons |
DELETE | /api/logistics/pvt/configuration/geoshape/{polygonName} | Delete polygon Deletes polygon set up in your store, by polygon name. Polygons |
GET | /api/logistics/pvt/configuration/holidays | List all holidays Lists information of all holidays. Holidays |
GET | /api/logistics/pvt/configuration/holidays/{holidayId} | List holiday by ID Lists holiday's information by holiday ID. Holidays |
PUT | /api/logistics/pvt/configuration/holidays/{holidayId} | Create/update holiday Creates or updates holidays through holiday ID. Holidays |
DELETE | /api/logistics/pvt/configuration/holidays/{holidayId} | Delete holiday Deletes given holidays set up in your store. Holidays |
GET | /api/logistics/pvt/configuration/pickuppoints | List all pickup points Lists all of your store's pickup points. Pickup points |
GET | /api/logistics/pvt/configuration/pickuppoints/_search | List paged Pickup Points Lists paged pickup points in your store. Pickup points |
GET | /api/logistics/pvt/configuration/pickuppoints/{pickupPointId} | List Pickup Point By ID Lists your store's pickup points while searching by ID. Pickup points |
PUT | /api/logistics/pvt/configuration/pickuppoints/{pickupPointId} | Create/Update Pickup Point Creates or updates [pickup points](https://help.vtex.com/en/subcategory/pickup-poin |
DELETE | /api/logistics/pvt/configuration/pickuppoints/{pickupPointId} | Delete Pickup Point Deletes a given pickup point for your store, by pickup point ID. Pickup points |
GET | /api/logistics/pvt/configuration/warehouses | List all warehouses Lists information about all warehouses set up in your store. Warehouses |
POST | /api/logistics/pvt/configuration/warehouses | Create/update warehouse Creates or updates your store's warehouses Warehouses |
GET | /api/logistics/pvt/configuration/warehouses/{warehouseId} | List warehouse by ID Lists the information of a given warehouse, searching by warehouse ID. Warehouses |
DELETE | /api/logistics/pvt/configuration/warehouses/{warehouseId} | Remove warehouse Deletes given warehouse by warehouse ID. Warehouses |
POST | /api/logistics/pvt/configuration/warehouses/{warehouseId}/activation | Activate warehouse Activates a given warehouse, by warehouse ID. Warehouses |
POST | /api/logistics/pvt/configuration/warehouses/{warehouseId}/deactivation | Deactivate warehouse Deactivates a given warehouse by warehouse ID. Warehouses |
GET | /api/logistics/pvt/inventory/items/{itemId}/warehouses/{warehouseId}/dispatched | List inventory with dispatched reservations Lists inventory with dispatched reservations. When the number of a |
GET | /api/logistics/pvt/inventory/items/{skuId}/docks/{dockId} | List inventory per dock Lists inventory information per dock set up in your store. Inventory |
GET | /api/logistics/pvt/inventory/items/{skuId}/docks/{dockId}/warehouses/{warehouseId} | List inventory per dock and warehouse Lists information of inventory per dock and warehouse. Inventory |
GET | /api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId} | List inventory per warehouse Lists inventory information per warehouse on your store. Inventory |
GET | /api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots | List supply lots Returns a list of the supply lots of an SKU in a specific warehouse. Inventory |
PUT | /api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots/{supplyLotId} | Save supply lot Creates a new Supply Lot. A Supply Lot lets the store sell products that are not currently ava |
POST | /api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots/{supplyLotId}/transfer | Transfer supply lot Transfers an SKU from a Supply Lot to the currently available inventory. Check out how th |
POST | /api/logistics/pvt/inventory/reservations | Create reservation Creates [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorial |
and 13 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Logistics API.json
>ℹ️ Check the new [Checkout onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/checkout-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about the Checkout and is organized by focusing on the developer's journey. The Checkout API allows you to obtain and configure information about
| method | path | what the vendor says it does |
|---|---|---|
POST | /api/checkout/pub/gatewayCallback/{orderGroup} | Process order Order processing callback request, which is made after an order's payment is approved. > This |
GET | /api/checkout/pub/orderForm | Get current or create a new cart You can use this request to get your current shopping cart information (`orde |
GET | /api/checkout/pub/orderForm/{orderFormId} | Get cart information by ID Use this request to get all information associated to a given shopping cart. Th |
POST | /api/checkout/pub/orderForm/{orderFormId}/attachments/clientPreferencesData | Add client preferences Use this request to include client preferences information to a given shopping cart. |
POST | /api/checkout/pub/orderForm/{orderFormId}/attachments/clientProfileData | Add client profile Use this request to include client profile information to a given shopping cart. The [or |
POST | /api/checkout/pub/orderForm/{orderFormId}/attachments/marketingData | Add marketing data Use this request to include marketing information to a given shopping cart. The [orderFo |
POST | /api/checkout/pub/orderForm/{orderFormId}/attachments/merchantContextData | Add merchant context data This endpoint is used for the merchant to add to the cart any relevant information t |
POST | /api/checkout/pub/orderForm/{orderFormId}/attachments/paymentData | Add payment data Use this request to include payment information to a given shopping cart. The payment informa |
POST | /api/checkout/pub/orderForm/{orderFormId}/attachments/shippingData | Add shipping address and select delivery option Use this request to include shipping information and/or select |
POST | /api/checkout/pub/orderForm/{orderFormId}/coupons | Add coupons to the cart Use this request to add coupons to a given shopping cart. Shopping cart |
PUT | /api/checkout/pub/orderForm/{orderFormId}/customData/{appId} | Set multiple custom field values Your account may create `apps`, which contain custom fields, through the [Upd |
PUT | /api/checkout/pub/orderForm/{orderFormId}/customData/{appId}/{appFieldName} | Set single custom field value Your account may create `apps`, which contain custom fields, through the [Update |
DELETE | /api/checkout/pub/orderForm/{orderFormId}/customData/{appId}/{appFieldName} | Remove single custom field value Your account may create `apps`, which contain custom fields, through the [Upd |
GET | /api/checkout/pub/orderForm/{orderFormId}/installments | Cart installments Retrieves possible amount of installments and respective values for a given cart with a give |
POST | /api/checkout/pub/orderForm/{orderFormId}/items | Add cart items Use this request to add a new item to the shopping cart. The [orderForm](https://developers. |
POST | /api/checkout/pub/orderForm/{orderFormId}/items/removeAll | Remove all items This request removes all items from a given cart, leaving it empty. You must send an empty |
POST | /api/checkout/pub/orderForm/{orderFormId}/items/update | Update cart items You can use this request to: 1. Change the quantity of one or more items in a specific ca |
PUT | /api/checkout/pub/orderForm/{orderFormId}/items/{itemIndex}/price | Change price This request changes the price of an SKU in a cart. You can also perform type of bulk price chang |
POST | /api/checkout/pub/orderForm/{orderFormId}/messages/clear | Clear orderForm messages This request removes all messages from the `messages` field of the orderForm , leavin |
PATCH | /api/checkout/pub/orderForm/{orderFormId}/profile | Ignore profile data When a shopper provides an email address at Checkout, the platform tries to retrieve exist |
POST | /api/checkout/pub/orderForm/{orderFormId}/transaction | Place order from an existing cart This endpoint places an order from an existing `orderForm` object, meaning a |
POST | /api/checkout/pub/orderForms/simulation | Cart simulation This endpoint is used to simulate a cart in VTEX Checkout. It receives an **SKU ID**, the * |
PUT | /api/checkout/pub/orders | Place order Places order without having any prior cart information. This means all information on items, clien |
GET | /api/checkout/pub/pickup-points | List pickup points by location Retrieves information on pickup points close to a given location determined by |
GET | /api/checkout/pub/postal-code/{countryCode}/{postalCode} | Get address by postal code Retrieves address information for a given postal code and country. This request |
GET | /api/checkout/pub/profiles | Get client profile by email Retrieve a client's profile information by providing an email address. If the r |
GET | /api/checkout/pub/regions/{regionId} | Get sellers by region or address Retrieve a list of sellers that cater to a specific region or address, accord |
GET | /api/checkout/pvt/configuration/orderForm | Get orderForm configuration Retrieves the settings that are currently applied to every orderForm in the accoun |
POST | /api/checkout/pvt/configuration/orderForm | Update orderForm configuration Determines settings that will apply to every orderForm in the account. For e |
GET | /api/checkout/pvt/configuration/window-to-change-seller | Get window to change seller Retrieves a marketplace’s window to change seller, that is, the period when it is |
POST | /api/checkout/pvt/configuration/window-to-change-seller | Update window to change seller Updates a marketplace’s window to change seller, that is, the period when it is |
GET | /checkout/changeToAnonymousUser/{orderFormId} | Remove all personal data This call removes all user information, making a cart anonymous while leaving the ite |
specification origin: https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Checkout API.json
> Check the new [Promotions onboarding guide](https://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. The Promotions & Taxes API allows you to manage and retrieve all prom
| method | path | what the vendor says it does |
|---|---|---|
POST | /api/rnb/pub/notifications | Usage notification Usage notification Notifications |
GET | /api/rnb/pvt/archive/benefits/calculatorConfiguration | List Archived Promotions Lists all archived promotions. Promotions and Taxes |
POST | /api/rnb/pvt/archive/calculatorConfiguration/{idCalculatorConfiguration} | Archive Promotion or Tax Archives a Promotion or Tax by its ID. Promotions and Taxes |
GET | /api/rnb/pvt/archive/coupon/{couponCode} | Get archived coupon by coupon code Retrieves a specific archived coupon by its coupon code. Coupons |
POST | /api/rnb/pvt/archive/coupon/{couponCode} | Archive coupon by coupon code Archives a specifc coupon by its coupon code. Coupons |
GET | /api/rnb/pvt/archive/taxes/calculatorConfiguration | List Archived Taxes Lists all archived taxes. Promotions and Taxes |
GET | /api/rnb/pvt/benefits/calculatorconfiguration | Get All Promotions Retrieves all promotions from an account. > 📘 Onboarding guide > > Check the new [Pr |
POST | /api/rnb/pvt/calculatorconfiguration | Create or Update Promotion or Tax Creates or updates a specific Promotion by its Promotion ID or a specific Ta |
GET | /api/rnb/pvt/calculatorconfiguration/{idCalculatorConfiguration} | Get Promotion or Tax by ID Retrieves a specific promotion by its Promotion ID or a specific tax by its Tax ID. |
GET | /api/rnb/pvt/campaignConfiguration | Get all campaign audiences Retrieves a list of all campaign audiences and their respective configurations. Cam |
POST | /api/rnb/pvt/campaignConfiguration | Create campaign audience Creates a new campaign audience. Campaign Audiences |
GET | /api/rnb/pvt/campaignConfiguration/{campaignId} | Get campaign audience configuration Retrieves a specific campaign audience configuration by its ID. This API u |
GET | /api/rnb/pvt/coupon | Get all coupons > Check the new [Promotions onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/p |
POST | /api/rnb/pvt/coupon | Update coupon Updates information of a specific coupon. Coupons |
POST | /api/rnb/pvt/coupon/ | Create coupon Creates a single new coupon. Coupons |
GET | /api/rnb/pvt/coupon/usage/{couponCode} | Get coupon usage Retrieves information about the coupon usage. Coupons |
GET | /api/rnb/pvt/coupon/{couponCode} | Get coupon by coupon code Retrieves a specific coupon by its coupon code. Coupons |
POST | /api/rnb/pvt/coupons | Coupon Massive Generation Generates a massive amount of coupons Coupons |
POST | /api/rnb/pvt/import/calculatorConfiguration | Create Multiple SKU Promotion Creates a Multiple SKU Promotion. This scenario allows to create a single promot |
PUT | /api/rnb/pvt/import/calculatorConfiguration/{promotionId} | Update Multiple SKU Promotion Updates information from a Multiple SKU Promotion. This scenario allows to creat |
POST | /api/rnb/pvt/multiple-coupons | Create multiple coupons Creates multiple coupons with different coupon codes. This endpoint has a throttling o |
GET | /api/rnb/pvt/taxes/calculatorconfiguration | Get All Taxes Retrieves all taxes from an account. Promotions and Taxes |
POST | /api/rnb/pvt/unarchive/calculatorConfiguration/{idCalculatorConfiguration} | Unarchive Promotion or Tax Unarchives a Promotion or Tax by its ID. Promotions and Taxes |
POST | /api/rnb/pvt/unarchive/coupon/{couponCode} | Unarchive coupon by coupon code Unarchives a specifc coupon by its coupon code. Coupons |
POST | /price-sheet | Save Price Save price. > If your account is using Pricing v2, you should avoid using these routes. Please ref |
GET | /price-sheet/all/{page}/{pageSize} | Get all paged prices Get all paged prices. > If your account is using Pricing v2, you should avoid using thes |
POST | /price-sheet/context | Get Price by context Get price by context. > If your account is using Pricing v2, you should avoid using thes |
GET | /price-sheet/{skuId} | Get Price by SKU ID Price by SKU ID > If your account is using Pricing v2, you should avoid usin |
DELETE | /price-sheet/{skuId} | Delete Price by SKU Id Delete all prices from an SKU. > If your account is using Pricing v2, you should avoid |
GET | /price-sheet/{skuId}/{tradePolicy} | Get Price by SKU ID and Trade Policy Retrieve price by SKU ID and Trade Policy. > If your account is using Pr |
POST | /pub/bundles | Calculate discounts and taxes (Bundles) Calculate discounts and taxes Bundles |
specification origin: https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Promotions & Taxes AP
VTEX Subscriptions REST API Documentation This documentation describes the available REST APIs for VTEX Subscription System. With Subscriptions you can set up regularly scheduled deliveries. All requests need authorization (VTEX Id authentication token or VTEX Appkey and Apptoken headers)
| method | path | what the vendor says it does |
|---|---|---|
GET | /report/reportStatus/{reportId} | Get report status by ID Retrieves the Subscription's report status, filtering by its reportId. Report |
GET | /report/subscriptionsByDate | Retrieve Subscription report by date Retrieves a report with the subscriptions created at the date interval re |
GET | /report/subscriptionsByStatus | Retrieve Subscription report by Status Retrieves Subscriptions' reports, filtering by status. The report will |
GET | /report/subscriptionsOrderByDate | Retrieve Subscription report by order date Retrieves a report regarding the Subscriptions created during the d |
GET | /report/subscriptionsScheduled | Retrieve Subscription report by schedule Retrieves a report regarding the Subscriptions scheduled to execute a |
GET | /report/subscriptionsUpdated | Request report by update Retrieves a report regarding Subscriptions updated in the date interval chosen. The r |
GET | /settings | Get Subscriptions Settings Lists the current Subscriptions settings in your store. Settings |
POST | /settings | Edit Subscriptions settings Edits Subscriptions settings in your store. Settings |
GET | /subscriptions | Retrieve customer's subscriptions Retrieves details of a given customer's subscriptions, searching by that cus |
GET | /subscriptions-group | List All subscription groups Retrieves all subscription groups in your store. Subscription Group |
GET | /subscriptions-group/list | Get subscription group list Retrieves a list of Subscription groups in your store. Subscription Group |
GET | /subscriptions-group/nextPurchase/{dateStr} | Get Next purchase Lists details of a given subscription group's next purchase, filtering by dateStr. Subscript |
GET | /subscriptions-group/simulate/{groupId} | Get Simulation by subscription-group Retrieves Subscription simulations, filtering by groupId. Subscription Gr |
GET | /subscriptions-group/{groupId} | Get Subscription by groupId Lists Subscription details, filtering by `groupId`. Subscription Group |
PATCH | /subscriptions-group/{groupId} | Update Subscription by groupId Updates a Subscription by `groupId`. Subscription Group |
POST | /subscriptions-group/{groupId}/additem | Add Subscription item by groupId Adds an SKU to a given Subscription, filtering by groupId. Subscription Group |
GET | /subscriptions-group/{groupId}/addresses | Get addresses by groupId Lists addresses linked to a given Subscription group, filtering by groupId. Subscript |
POST | /subscriptions-group/{groupId}/addresses | Insert Addresses by groupId Insert address information of a given Subscription group, filtering by groupId. Su |
PATCH | /subscriptions-group/{groupId}/cancel | Cancel Subscription by groupId Cancels Subscription by `groupId` Subscription Group |
GET | /subscriptions-group/{groupId}/config | List Subscription group's Configuration Retrieves details about a given subscription group's configuration, fi |
GET | /subscriptions-group/{groupId}/conversation-message | Get Conversation Message by groupId Retrieves the conversation of a given Subscription group, filtering by gro |
GET | /subscriptions-group/{groupId}/frequency-options | Get frequency options by groupId Lists frequency options of a given Subscription group, filtering by groupId. |
GET | /subscriptions-group/{groupId}/payment-systems | Get payment System by groupId Retrieves payment system's information of a given Subscription group, filtering |
GET | /subscriptions-group/{groupId}/will-create | List 'Will create' by groupId Retrieves Subscription groups listed as 'will create', filtering by groupId. Sub |
POST | /subscriptions-group/{groupid}/instances/{instanceId}/retry | Retry subscription by groupId Permits the retry of a Subscription group, via API, filtering by groupId and ins |
GET | /subscriptions/list | Get Subscription List Retrieves a list of Subscriptions linked to your store. Subscriptions |
GET | /subscriptions/{subscriptionId} | Retrieve subscription by ID Lists Subscription's details, searching by `subscriptionId`. Subscriptions |
PATCH | /subscriptions/{subscriptionId} | Update Subscriptions by SubscriptionId Update, add or alter information of a given Subscription, filtering by |
POST | /subscriptions/{subscriptionId}/addresses | Insert Addresses for Subscription Inserts address's information to complement the Subscription details. Subscr |
PATCH | /subscriptions/{subscriptionId}/cancel | Cancel Subscriptions by SubscriptionId Cancels all Subscriptions of a subscription group. This operation does |
GET | /subscriptions/{subscriptionId}/frequency-options | Get frequency options by subscriptionId Lists frequency options for the Subscription, filtering by `subscripti |
specification origin: https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Subscriptions API (v2
>Check the new [Orders onboarding guide](https://developers.vtex.com/docs/guides/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. Receive, process, and manage every order in your store through our Order Management API.
| method | path | what the vendor says it does |
|---|---|---|
GET | /api/checkout/pvt/configuration/window-to-change-seller | Get window to change seller Retrieves a marketplace’s window to change seller, that is, the period when it is |
POST | /api/checkout/pvt/configuration/window-to-change-seller | Update window to change seller Updates a marketplace’s window to change seller, that is, the period when it is |
GET | /api/oms/pvt/admin/reports/completed | Export order report with status 'Completed' Retrieves a list of all order reports that are `completed`, by `ac |
GET | /api/oms/pvt/admin/reports/inprogress | Export order report with status 'In Progress' Retrieves a list of all order reports that are `in progress`, by |
GET | /api/oms/pvt/feed/orders/status | Get feed order status Get feed order status (deprecated) Feed v2 (deprecated) |
GET | /api/oms/pvt/orders | List orders Retrieves a list of orders according to the filters described below. The limit of information |
GET | /api/oms/pvt/orders/{orderId} | Get order This endpoint retrieves order details by searching a specific order ID or sequence number. > The |
POST | /api/oms/pvt/orders/{orderId}/cancel | Cancel order You should use this endpoint to cancel an order by its order identification number (the `orderId` |
POST | /api/oms/pvt/orders/{orderId}/changes | Register change on order > Timeout settings > > This is a synchronous API, which means the application reque |
GET | /api/oms/pvt/orders/{orderId}/conversation-message | Retrieve order conversation List all order conversations of an order by its order ID. Conversation |
POST | /api/oms/pvt/orders/{orderId}/interactions | Add log in orders Add a Log in Interactions Order Array. Orders |
POST | /api/oms/pvt/orders/{orderId}/invoice | Order invoice notification Entering the [invoice in the order](https://help.vtex.com/en/tracks/orders--2xkTisx |
PATCH | /api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber} | Update order's partial invoice (send tracking number) Update a given order, adding its tracking number to its |
PUT | /api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}/tracking | Update order tracking status This endpoint sends a tracking event to an order that already has a tracking numb |
GET | /api/oms/pvt/orders/{orderId}/payment-transaction | Retrieve payment transaction Retrieves transaction details by order ID. All events in the transaction will be |
POST | /api/oms/pvt/orders/{orderId}/payments/{paymentId}/payment-notification | Send payment notification Send a payment notification of a given order, by order ID. > The `Notify payment` |
POST | /api/oms/pvt/orders/{orderId}/start-handling | Start handling order Changes the status of an order to indicate that it is in `handling`. > Expect a `statu |
GET | /api/oms/user/orders | Retrieve user's orders Lists all orders from a given client, filtering by their email. > Note that these r |
GET | /api/oms/user/orders/{orderId} | Retrieve user order details Lists all details from a user's order, through client's perspective. > Note th |
POST | /api/orders/expressions/jsonata | Test JSONata expression This endpoint allows you to test a JSON document with a JSONata expression, returning |
GET | /api/orders/feed | Retrieve feed items Retrieve items from [feed](https://developers.vtex.com/docs/guides/orders-feed) queue. |
POST | /api/orders/feed | Commit feed items Commit items in the [feed](https://developers.vtex.com/docs/guides/orders-feed) queue. Feed |
GET | /api/orders/feed/config | Get feed configuration The Orders Feed v3 is the best way to create order integrations. Below you can find det |
POST | /api/orders/feed/config | Create or update feed configuration The Orders Feed v3 is the best way to create order integrations. Below you |
DELETE | /api/orders/feed/config | Delete feed configuration Deletes the configuration set up in [Feed v3](https://developers.vtex.com/docs/guide |
GET | /api/orders/hook/config | Get hook configuration Retrieves a given hook's configuration details. Learn more with the [orders hook guide] |
POST | /api/orders/hook/config | Create or update hook configuration Configures filtering rules applied to orders hook. Learn more with the [or |
DELETE | /api/orders/hook/config | Delete hook configuration Deletes a given hook configuration. Learn more with the [orders hook guide](https |
specification origin: https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Orders API.json
Create shopper profiles and manage their information.
| method | path | what the vendor says it does |
|---|---|---|
POST | /api/storage/profile-system/profiles | Create client profile Creates new client profile. > Since your store's profile schema is customizable, the |
PUT | /api/storage/profile-system/profiles/schema | Create or update profile schema Creates or updates profile schema. > Each account has one profile schema. U |
GET | /api/storage/profile-system/profiles/{profileId} | Get profile Retrieves the information of a specific client, by its `profileId`. > Since your store's profil |
PATCH | /api/storage/profile-system/profiles/{profileId} | Updates client profile Updates one or more fields of an existing client profile. > Since your store's profi |
DELETE | /api/storage/profile-system/profiles/{profileId} | Delete client profile Deletes a client profile by `profileId`. > Learn more about the [Profile System](http |
GET | /api/storage/profile-system/profiles/{profileId}/addresses | Get client addresses Retrieves information of all addresses of a given client, by its `profileId`. > For se |
POST | /api/storage/profile-system/profiles/{profileId}/addresses | Create client address Creates new address for a given client profile. > The `id` field returned by this req |
GET | /api/storage/profile-system/profiles/{profileId}/addresses/unmask | Get unmasked client addresses Retrieves unmasked information of all addresses of a given client, by its `profi |
GET | /api/storage/profile-system/profiles/{profileId}/addresses/{addressId} | Get address Retrieves information of a specific address of a given client, by its respectives `adderssId` and |
PATCH | /api/storage/profile-system/profiles/{profileId}/addresses/{addressId} | Update client address Updates one or more fields of an existing address for a given client profile. > Learn |
DELETE | /api/storage/profile-system/profiles/{profileId}/addresses/{addressId} | Delete address Deletes a client's address by `profileId` and `addressId`. > Learn more about the [Profile S |
GET | /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/unmask | Get unmasked address Retrieves unmasked information of a specific address of a given client, by its respective |
GET | /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/versions/{addressVersionId} | Get address by version Retrieves information of a specific version address of a given client. > For securit |
GET | /api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/versions/{addressVersionId}/unmask | Get unmasked address by version Retrieves unmasked information of a specific address version of a given client |
GET | /api/storage/profile-system/profiles/{profileId}/purchase-info | Get purchase information Retrieves purchase information of a given client, by its `profileId`. > For securi |
POST | /api/storage/profile-system/profiles/{profileId}/purchase-info | Create purchase information Creates purchase information for a given client profile. > Learn more about the |
PATCH | /api/storage/profile-system/profiles/{profileId}/purchase-info | Update purchase information Updates one or more fields of existing purchase information for a given client pro |
DELETE | /api/storage/profile-system/profiles/{profileId}/purchase-info | Delete purchase information Deletes purchase informaiton by `profileId`. > Learn more about the [Profile Sy |
GET | /api/storage/profile-system/profiles/{profileId}/purchase-info/unmask | Get unmasked purchase information Retrieves unmasked purchase information of a given client, by its `profileId |
GET | /api/storage/profile-system/profiles/{profileId}/unmask | Get unmasked profile Retrieves unmasked information of a specific client, by its `profileId`. > Since your |
GET | /api/storage/profile-system/profiles/{profileId}/versions/{profileVersionId} | Get profile by version Retrieves the information of a specific version of a client profile. > Since your st |
GET | /api/storage/profile-system/profiles/{profileId}/versions/{profileVersionId}/unmask | Get unmasked profile by version Retrieves unmasked information of a specific version of a client profile. > |
POST | /api/storage/profile-system/prospects | Create prospect Creates new prospect. > The `id` field returned by this request is the `prospectId` used to |
GET | /api/storage/profile-system/prospects/{prospectId} | Get prospect Retrieves the information of a specific prospect, by its `prospectId`. > For security and priv |
PATCH | /api/storage/profile-system/prospects/{prospectId} | Update prospect Updates one or more fields of an existing prospect. > Learn more about the [Profile System] |
DELETE | /api/storage/profile-system/prospects/{prospectId} | Delete prospect Deletes a prospect by `prospectId`. > Learn more about the [Profile System](https://develop |
GET | /api/storage/profile-system/prospects/{prospectId}/unmask | Get unmasked prospect Retrieves unmasked information of a specific prospect, by its `prospectId`. > Learn m |
specification origin: https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Profile System.json
With Customer Credit your store can enable **credit payments** through the checkout. You can also control **invoices** and the **credit limits** of your clients. Learn more about Customer Credit in our [Help Center article](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/36grlQ69NK6OCuioeekyCs). All requests need the **authorization header**. Additi
| method | path | what the vendor says it does |
|---|---|---|
GET | /api/creditcontrol/accounts | Search all accounts Account |
POST | /api/creditcontrol/accounts | Open an Account Open an account. Account |
PUT | /api/creditcontrol/accounts/{accountId} | Open or Change Account Open or Change an account. Account |
GET | /api/creditcontrol/accounts/{creditAccountId} | Retrieve an Account by Id Retrieve an account by id. Account |
PUT | /api/creditcontrol/accounts/{creditAccountId} | Update email and description of a account Update a checking account. Account |
DELETE | /api/creditcontrol/accounts/{creditAccountId} | Close an Account Closes an account. Account |
PUT | /api/creditcontrol/accounts/{creditAccountId}/creditlimit | Change credit limit of an Account Increase the credit limit of an account. Account |
POST | /api/creditcontrol/accounts/{creditAccountId}/holders | Add an account Holder Account |
DELETE | /api/creditcontrol/accounts/{creditAccountId}/holders/{holderId} | Delete an account holder Account |
GET | /api/creditcontrol/accounts/{creditAccountId}/invoices | Retrieve invoice by creditAccountId Returns associated invoices by specified creditAccountId, the param that i |
GET | /api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId} | Retrieve Invoice by Id Returns associated data for the specified Invoice Id, like status and value, for examp |
and 15 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Customer Credit API.j
# ATTENTION: **This version isn't compliant with data entities of old version (e.g. CL and AD). It's possible to use this configuration only to new data entities.** ## Welcome! VTEX Master Data is an easy-to-use, secure, fast, scalable and extensible repository. On it you can create your own Entities, store data and consult directly from the storefront or use it to store info for some exte
| method | path | what the vendor says it does |
|---|
and 26 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Master Data API - v2.
>ℹ️ Onboarding guide > > Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey. The Payments Gateway API allows you to get payment data an
| method | path | what the vendor says it does |
|---|
and 22 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Payments Gateway API.
MasterData API - v1, an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|
and 20 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - MasterData API - v10.
A **Subscription** is a list of items (SKUs) tied to certain recurring purchase settings: - User profile - Address - Payment method - Frequency - Cycle Once you have [configured subscriptions](https://help.vtex.com/tutorial/how-to-configure-subscriptions%20--1FA9dfE7vJqxBna9Nft5Sj) in your store, the Subscriptions API allows you to create, manage and monitor your customers' subscriptions
| method | path | what the vendor says it does |
|---|
and 20 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Subscriptions API (v3
and 21 more specification(s) from vtex.local, all indexed.
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.