diff --git a/public/docs/api-guides/billing-options.md b/public/docs/api-guides/billing-options.md deleted file mode 100644 index 4734b3da..00000000 --- a/public/docs/api-guides/billing-options.md +++ /dev/null @@ -1,105 +0,0 @@ -# Billing Options - -The `billingOptions` field is part of the `manifest.json` file of an app and is used to define all the necessary metadata for distributing an app on the VTEX ecosystem. The `billingOptions` field allows you to charge for an app, make it public, and determine its pricing settings. - -Please notice that apps without `billingOptions` in the `manifest.json` file are **private**, meaning that they are only visible and available for installation in the account where they were published. - ->ℹ️ Setting your app's billing model is a necessary step to distribute your app on the VTEX ecosystem. Without the `billingOptions` definition, the visibility of your app is restricted to the account where it was published. Learn how to configure the `billingOptions` field in [Setting your app's billing model](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-setting-your-apps-billing-model) according to your scenario. - -Refer to the following sections to find more details on the properties that comprise the `billingOptions` field. - -## Properties - -| Property | Type | Description | Valid example | -| --------- | ----- | --------------- | ------- | -| `type` | `enum` | Defines how the app is charged. Possible values are: `free` (app is free of charge), `billable` (app charges according to one of its plans) or `sponsored` (app is meant to be used only by a [Sponsor account](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-sponsor-account) and its children). | `free` | -| `support` | `object` | Provides a support request channel between the app’s user and its vendor. To know more, check out the [`support` object](#support-object) section below. | `undefined` | -| `availableCountries` | `array` | Defines the countries ID (ISO) where the app can be installed and where support is ensured by the vendor. | `["BRA", "USA", "GBR"]` or `["*"]` *(meaning that the app is available in any country)* | -| `plans` | `array` | **Optional property.** Defines (in an object array) a predefined subscription plan. To know more, check out the [`plans` array](#plans-array) section below. | `undefined` | - -### **`support` object:** - -| Property | Type | Description | Valid example | -| -------- | ------- | --------- | -------- | -| `email` | `string` | Email address where users can request support. | `example@example.com` | -| `url` | `string` | **Optional property.** URL where users can request support. | `example.com/support` | -| `phone` | `string` | **Optional property.** Phone number (in full international format) where users can request support. | `+5521988887777` | - -Valid example of the object: - -```json -"support": { - "url": "https://example.com/support", - "email": "example@example.com", - "phone": "+5521988887777" -}, -``` - -### **`plans` array:** - -| Property | Type | Description | Valid example | -| -------- | ------- | --------- | -------- | -| `id` | `string` | Unique plan identifier containing one or more letters or numbers from the english alphabet. | `BRAplan23`, `planShipping` | -| `currency` | `string` | A valid [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code to be used for the app’s subscription value. Currently, only `BRL` and `USD` are supported. | `BRL`, `USD` | -| `price` | `object` | Contains subscription pricing values for the billable app. All values follow the same unit set in the `currency` prop. For more info, check out the [`price` object](#price-object) section below. | `undefined` | - -Valid example of the object: - -```json -"plans": [{ - "id": "BRAplan23", - "currency": "BRL", - "price": {...} -}] -``` - -- **`price` object:** - -| Property | Type | Description | Valid example | -| -------- | ------- | --------- | -------- | -| `subscription` | `number` | The subscription’s *monthly* price. | `19.99` | -| `metrics` | `array` | Defines (in an object array) the criteria on which the variable fee will be based on, according to the app’s use. Only use this property if you also want to charge your app users according to the app usage (in addition to the subscription fee). To know more, check out the [`metrics` array](#metrics-array) section below. | `undefined` | - -Valid example of the object: - -```json -"price" { - "subscription": 50, - "metrics": [{...}] -} -``` - -### **`metrics` array:** - -| Property | Type | Description | Valid example | -| -------- | ------- | --------- | -------- | -| `id` | `string` | Unique metric identifier (across all metrics within the plan) containing one or more *letters* or *numbers* from the english alphabet. | `CreditMetric23` | -| `ranges` | `array` | Defines (in an object array) the range used to calculate the app’s use and the variable fee that users should be charged. To know more, check out the [`ranges` array](#ranges-array) section below. | `undefined` | -| `customURL` | `string` | Reliable `URL` address containing information on how to get the metric value. | `mycredit.com/app/3/metric-value` | - -Valid example of the object: - -```json -{ - "id": "notificationSent", - "ranges": [{...}], - "customUrl": "https://metrics.com/_v/metric/billing/info" -} -``` - -### **`ranges` array:** - -| Property | Type | Description | Valid example | -| -------- | ------- | --------- | -------- | -| `multiplier` | `number` | A positive number that is going to be multiplied by the metric value to calculate the price that will be charged. | `0.07`, `1.99`, `5` | -| `exclusiveFrom` | `number` | A number that denotes the start of the range (but doesn't include that number itself in the range). | `0`, `100`, `33.33` | -| `inclusiveTo` | `number` | A number that denotes the end of the range (including that number itself). | `100`, `500`, `999.99` | - -Valid example of the object: - -```json -"ranges": [{ - "exclusiveFrom": 0, - "multiplier": 0.08 -}] -``` \ No newline at end of file diff --git a/public/docs/api-guides/clients.md b/public/docs/api-guides/clients.md deleted file mode 100644 index af23d48c..00000000 --- a/public/docs/api-guides/clients.md +++ /dev/null @@ -1,20 +0,0 @@ -# Clients - -Systems are meant to solve real problems by communicating to the needed services. A delivery app, for example, solves the issue of the desire to eat by communicating with a local restaurant service. - -On VTEX IO architecture, the communication made by a system to request a service is so crucial that a whole concept was built for it: **Clients**. - -In other words, Clients are configurations to be set up in a given system to **abstract its communications to the needed services**. - -When building software, you can tackle complexities by setting up clients and then optimizing your code. Some standard clients are already into the VTEX IO. Check them [here](https://github.com/vtex/node-vtex-api/blob/ccf4d8f8d3208007c4bfd558baf979df8d825af8/src/clients/IOClients.ts). - -These are some of the features built-in our clients infrastructure: - - - Cache; - - Native metrics support; - - Retry and timeout options; - - Billing tracking. - -![Clients on IO Services](https://imgur.com/i45O8MN.png) - -Learn how to create Clients of your own by accessing [Managing Clients](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-how-to-create-and-use-clients) documentation. diff --git a/public/docs/api-guides/developing-an-app.md b/public/docs/api-guides/developing-an-app.md deleted file mode 100644 index f0c3a0e9..00000000 --- a/public/docs/api-guides/developing-an-app.md +++ /dev/null @@ -1,209 +0,0 @@ -# Developing an app - -In this guide, you will learn how to develop an app using the VTEX IO platform. You will be presented with some core concepts of the platform and guided through the necessary steps to have a running application in VTEX IO. - -[VTEX IO](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-what-is-vtex-io) is a cloud-native development platform that allows you to develop web storefronts, custom admin apps, and backend integrations for VTEX. - - -## Before you start -Make sure to install the [VTEX IO CLI (Command Line Interface) in your machine](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-vtex-io-cli-install). - -Any development in VTEX IO begins and ends with our CLI (Command Line Interface). VTEX IO's CLI allows you to perform any action necessary to your app development process, such as linking local files to the VTEX platform, managing workspaces, and releasing new app versions. - -## Step-by-step - -### Step 1 - Creating an app - -When developing an app in VTEX IO, you can start one from scratch or use one of our boilerplates. Our boilerplates contain implementation examples and all the initial settings needed for you to start developing an app. Take a look at the available boilerplates: - -| Boilerplate name | Description | -| ---------------------- | ---------------- | -| `graphql-example` | Implements a [VTEX IO service with GraphQL resolvers](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-developing-service-configuration-apps#if-you-are-developing-a-graphql-app). | -| `payment-provider-example` | Implements a [Payment-Provider protocol](https://developers.vtex.com/vtex-rest-api/docs/payments-integration-payment-provider-protocol) | -| `admin-example` | Implements an admin app that adds a menu button to the admin sidebar and navigation via parameter example. | -| `store` | Implements the basic structure of a VTEX Store Framework storefront. | -| `service-example` | Implements a [VTEX IO service](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-developing-service-configuration-apps) with HTTP route handlers. | -| `render-guide` | Guide repository for an app with all common patterns in app development, such as pagination and editing entities. | -| `edition app` | Creates an an [Edition app](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-edition-app). | -| `react-guide` | Creates a frontend app with React. See… [react app](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io). | -| `checkout-ui-settings` | Guide repository for the Checkout UI Settings app, responsible for A/B testing in your store's scripts, in addition to the possibility of quick rollbacks for old scripts, i.e., scripts of older Checkout UI Settings app's versions. | -| `service-worker-example` | Guide repository for apps that enable service-worker builder to expose Service Worker. | -| `admin-ui-example` | Guide repository for Admin apps for the admin v4 with the admin-ui design system. | - -#### Cloning the boilerplate repository to your local files - -1. Open the terminal and clone the boilerplate you desire by running the following command: - -``` -vtex init -``` - -2. Select the boilerplate that you want. - -![boilerplates](https://user-images.githubusercontent.com/67270558/156827878-b43f13b6-3ba0-48d8-b425-ed7790e3ba5f.png) - -3. A new folder will be created in your machine, and to access it run `cd {folder-name}` in your terminal. - -> ℹ️ -> -> Change the name in the curly brackets to the boilerplate that you choose, for example `cd graphql-example` - - -#### Editing the manifest.json file -Once you have [cloned the boilerplate repository](#cloning-the-boilerplate-repository-to-your-local-files) into your local files, let's learn how to make it your own by editing the **`manifest.json`** file. - -> ℹ️ -> -> The `manifest.json` file saves essential information about a VTEX IO app, such as its name, version, vendor, description, dependencies, etc. It is the core communication of your app with the VTEX IO platform. For more information, see the [Manifest article](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-manifest). - -1. Open the boilerplate project you started in [the previous step](#cloning-the-boilerplate-repository-to-your-local-files) in any code editor of your choice. - -2. Open the `manifest.json` file and look at the primary information that it provides, such as in the [Manifest article](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-manifest). - -3. Change the following fields according to your scenario: - -- Replace the value of the `name` field with the name of your app. - -- Replace the value of the `vendor` field with the VTEX account you are using for development. This should be the name of the VTEX account resposible for the app development, maintenance, and distribution. - -- Replace the value of the `version` field with the app version, according to the [Semantic Versioning 2.0.0](https://semver.org/). - -- Replace the value of the `title` field with the app distribution name. This name will be displayed on the Apps section in the admin and on the VTEX App Store. - -- Replace the value of the `description` field with a brief description of the app's functionality. - - - -4. Go to the **`builders`** prop and add the ones that make sense for your app project. - - -> ℹ️ Info -> -> A Builder defines the nature of an app. If you are developing a frontend app, you'll probably want to use the `react` builder. Instead, if you're developing a backend integration, you'll probably want to use the `node` or `dotnet` builder. In summary, a builder is responsible for processing, validating, and forwarding a given block of code to a runtime or a framework capable of executing it. Notice that an app can have as many builders as you want. That allows bundling front and backend development and delivering your solution with just one package. Please refer to the [Builders article](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-builders) for more information. - -5. Install the [dependencies](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-dependencies) and [peer dependencies](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-peerdependencies) necessary for your app to properly work by relying on VTEX IO apps and other apps, respectively. - -6. Save your changes. - -So far, you have created an app and made it your own. Now, it is time to start making changes to your code and use a development server to see your changes live. - -### Step 2 - Starting the app development -In this step, you will create a a development workspace to perform the necessary changes in your app without worrying about the app's live version and see your changes in real-time by sending the app’s changes to our cloud platform. - -#### Logging in to your VTEX account - -This step will guarantee that your VTEX account is in sync with the VTEX IO development platform and allow you to manage the development and publishing of the app. - -1. Once installed the [VTEX IO CLI](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-vtex-io-cli-install), log in to your VTEX account with the following command: - -``` -$ vtex login {accountName} -``` - -> ⚠️ -> -> ️ Replace `{accountName}` with the name of your VTEX account. - -2. A browser window will open and ask for your credentials. - -3. Once logged in, run the `vtex whoami` command to show which account and workspace the VTEX IO CLI is using. - - -![Login - Whoami](https://user-images.githubusercontent.com/67270558/151855497-21a966cf-9529-42df-8e25-27245f8e26f2.png) - -#### Creating a development workspace -When using VTEX IO, any development must happen in a [workspace](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-workspace). - -> ℹ️ Info -> -> **Workspaces** are environments isolated from one another. They can be understood as different versions of the same VTEX account. In practice, changes performed in a particular workspace do not affect your app’s live version or other developers' work. -Refer to the [Workspace article](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-workspace) for more information. - -To start developing, you have to create a [Development workspace](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-creating-a-development-workspace) in your VTEX account. When you log in, you automatically use the Master workspace, which means you are in the version available to the end-user. - -1. Run the `vtex use` command in your terminal as shown below: - -``` -$ vtex use {exampleName} -``` -This changes your VTEX account to a Developer workspace called `exampleName` ( ️ replace it with the name of your choice), creating it from scratch if it does not already exist. - - -![vtex-use](https://raw.githubusercontent.com/vtex-apps/io-documentation/master/docs/en/GettingStarted/develop-storefront-apps-using-react-and-vtex-io/assets/basic-development-setup-in-vtex-io-2.png) - -2. Type `Y`, and a Development workspace will be created under your chosen name. - -So far, you have created an app and have a Development workspace to perform any changes in your code. In the following section, you will learn how to sync the changes performed in your app to our cloud development environment by linking the app. - -#### Starting a development server -Now that you have your app up and running on your machine, it is time to send all the changes you have performed locally so far to the cloud and reflect them in the workspace in which you are working. In other words, you will be able to see your changes in real-time by accessing the account you are logged in using the workspace you are using to develop. - -1. Run `vtex whoami` in your terminal and make sure you are logged into the desired account using the development workspace you have created. - -2. In the terminal, access the app's directory in your local files. - -3. Once in the accurate directory, type the following command in the terminal: -``` -vtex link -``` - -After that, every change can be seen in your browser in real-time, and you can access it by running `vtex browse` in your terminal. - - - -## Next Steps -Now that you have created your app and it is already live in your development workspace, here are some options of what you can do next: - -- [Manage application logs](https://developers.vtex.com/vtex-developer-docs/docs/managing-application-logs): keep track of errors, warnings, and informative events with VTEX IO logging service. - -- [Run A/B tests](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-running-native-ab-testing): Optimize your store's conversion rates by running A/B tests. - -- [Release a new app version](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-releasing-a-new-app-version): Release a new app version If you’re sure about all the code changes that you’ve done to your app in a development workspace. - -- [Create a Production workspace](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-creating-a-production-workspace): Create a Production workspace to test in a user traffic environment the changes you performed in a development workspace Once you are sure of your changes performed in the Development workspace with traffic. - -- [Promote a workspace to Master](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-promoting-a-workspace-to-master): Promoting a workspace to Master marks the final step to make an app publicly available to end-users. - -### Developing for the VTEX App Store - -If you are developing an app that will be distributed to the [VTEX App Store](https://apps.vtex.com/) make sure to check the following guidelines: - -- [Engineering Guidelines](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-engineering-guidelines) - The Engineering guidelines are your go-to guides to learn the coding standards to develop an app using the VTEX IO infrastructure, such as scalability, performance, security and data privacy. - -- [User experience guidelines](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-design-guidelines) - Learn how you can design an app to meet the VTEX App Store requirements. - - -- Business Guidelines - The Business Guidelines are divided in two: - - [App monetization](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-business-guidelines-app-monetization): Learn the types of business models for your app. - - - [Marketing assets](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-business-guidelines-marketing-assets): Learn how to prepare the assets to market the app in the VTEX App Store. - -## Related Articles - -### Concepts - -- [Manifest](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-manifest#vendor) - -- [Builders](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-builders) - -- [Dependencies](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-dependencies) - -- [Workspace](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-workspace/) - -### Tutorials - -- [Developing Storefront apps](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io) - -- [Developing Pixel Apps](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-1-developnativeintegrationswithpixelapps) - -### Guides - -- [Installing the VTEX IO CLI](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-vtex-io-cli-install) - -- [Linking an app](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-linking-an-app) - -- [Service](https://developers.vtex.com/vtex-developer-docs/docs/back-end-development-guides) - -- [Developing services on VTEX IO](https://learn.vtex.com/docs/course-service-course-lang-en) - - diff --git a/public/docs/api-reference/Catalog-API.json b/public/docs/api-reference/Catalog-API.json deleted file mode 100644 index 358b0677..00000000 --- a/public/docs/api-reference/Catalog-API.json +++ /dev/null @@ -1,21978 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "Catalog API", - "description": "Methods for collecting product/sku catalog data, categories, brands and other information.\n

\nAll content that comes between {{}} keys must be replaced with the correct data before performing the request.\n

\nCommon parameters that must be changed in most VTEX requests\n
\n{{accountName}} => Store account name\n
\n{{environment}} => The environment that will be called. Change for vtexcommercestable or vtexcommmercebeta\n
\n{{X-VTEX-API-AppKey}} => Located in the headers of the requests, user authentication key\n
\n{{X-VTEX-API-AppToken}} => Located in the headers of the requests, authentication password", - "contact": {}, - "version": "1.0" - }, - "servers": [ - { - "url": "https://{accountName}.{environment}.com.br", - "description": "VTEX server url", - "variables": { - "accountName": { - "description": "Name of the VTEX account. Used as part of the URL", - "default": "{accountName}" - }, - "environment": { - "description": "Environment to use. Used as part of the URL.", - "default": "{environment}" - } - } - } - ], - "paths": { - "/api/catalog_system/pvt/products/GetProductAndSkuIds": { - "get": { - "tags": [ - "Product" - ], - "summary": "Get Product and SKU IDs", - "description": "Retrieves the IDs of all products and SKUs from a specific category by its category ID. \n[block:api-header]%7B%22title%22%3A%22This%20is%20a%20Readme%20header%22%7D[/block]\nThis is some text. `code`\n\n# This is a markdown header\n\n#### This is a html table outside of a magic block\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeMandatoryDescription
cardholderDocumentstringDescribes the need for cardholder documentation to process antifraud analysis. Accepted values:\n
\nrequired: a cardholder document is mandatory. \n
\noptional: a cardholder document can be used, but is not required. \n
\nunused: a cardholder document is not required.
customFieldsobjectDescribes the customized fields supported by the connector
↳ namestringYesCustom field name
↳ typestringYesCustom field type. Accepted values: text, select
↳ optionsstringIn case of select type, the possible params are text and value
          ↳textobjectCustom field description
          ↳valuestringCustom field value
\n\n
\n\n#### These are code magic blocks\n\n[block:code]%7B%22codes%22%3A%5B%7B%22code%22%3A%22curl%20--location%20--request%20POST%20'%7B%7Bantifraud-provider-service-url%7D%7D%2Fpre-analysis'%20%5C%5C%5Cn--header%20'Content-Type%3A%20application%2Fjson'%20%5C%5C%5Cn--header%20'X-PROVIDER-API-AppKey%3A%20ProviderAppKey'%20%5C%5C%5Cn--header%20'X-PROVIDER-API-AppToken%3A%20ProviderAppToken'%20%5C%5C%5Cn--data-raw%20'%7B%5Cn%20%20%5C%22id%5C%22%3A%20%5C%22D3AA1FC8372E430E8236649DB5EBD08E%5C%22%2C%5Cn%20%20%5C%22reference%5C%22%3A%20%5C%22v32478982vtx-01%5C%22%2C%5Cn%20%20%5C%22value%5C%22%3A%2010%2C%5Cn%20%20%5C%22ip%5C%22%3A%20%5C%2210.0.0.1%5C%22%2C%5Cn%20%20%5C%22deviceFingerprint%5C%22%3A%20%5C%22Generated_using_GTM_Store_Is_Responsible_To_Configure%5C%22%2C%5Cn%20%20%5C%22miniCart%5C%22%3A%20%7B%5Cn%20%20%20%20%5C%22buyer%5C%22%3A%20%7B%5Cn%20%20%20%20%20%20%5C%22id%5C%22%3A%20%5C%22c1245228-1c68-11e6-94ac-0afa86a846a5%5C%22%2C%5Cn%20%20%20%20%20%20%5C%22firstName%5C%22%3A%20%5C%22John%5C%22%2C%5Cn%20%20%20%20%20%20%5C%22lastName%5C%22%3A%20%5C%22Doe%5C%22%2C%5Cn%20%20%20%20%20%20%5C%22document%5C%22%3A%20%5C%22012.345.678-90%5C%22%2C%5Cn%20%20%20%20%20%20%5C%22documentType%5C%22%3A%20%5C%22CPF%5C%22%2C%5Cn%20%20%20%20%20%20%5C%22email%5C%22%3A%20%5C%22john%40doe.com%5C%22%2C%5Cn%20%20%20%20%20%20%5C%22phone%5C%22%3A%20%5C%22%2B5521987654321%5C%22%2C%5Cn%20%20%20%20%20%20%5C%22address%5C%22%3A%20%7B%5Cn%20%20%20%20%20%20%20%20%5C%22country%5C%22%3A%20%5C%22BRA%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22street%5C%22%3A%20%5C%22Rua%20Praia%20de%20Botafogo%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22number%5C%22%3A%20%5C%22518%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22complement%5C%22%3A%20%5C%222o.%20andar%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22neighborhood%5C%22%3A%20%5C%22Botafogo%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22postalCode%5C%22%3A%20%5C%2222250-040%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22city%5C%22%3A%20%5C%22Rio%20de%20Janeiro%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22state%5C%22%3A%20%5C%22RJ%5C%22%5Cn%20%20%20%20%20%20%7D%5Cn%20%20%20%20%7D%2C%5Cn%20%20%20%20%5C%22shipping%5C%22%3A%20%7B%5Cn%20%20%20%20%20%20%5C%22value%5C%22%3A%208.41%2C%5Cn%20%20%20%20%20%20%5C%22estimatedDate%5C%22%3A%20%5C%222017-08-02T14%3A46%3A47%5C%22%2C%5Cn%20%20%20%20%20%20%5C%22address%5C%22%3A%20%7B%5Cn%20%20%20%20%20%20%20%20%5C%22country%5C%22%3A%20%5C%22BRA%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22street%5C%22%3A%20%5C%22Rua%20Praia%20de%20Botafogo%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22number%5C%22%3A%20%5C%22518%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22complement%5C%22%3A%20%5C%222o.%20andar%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22neighborhood%5C%22%3A%20%5C%22Botafogo%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22postalCode%5C%22%3A%20%5C%2222250-040%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22city%5C%22%3A%20%5C%22Rio%20de%20Janeiro%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22state%5C%22%3A%20%5C%22RJ%5C%22%5Cn%20%20%20%20%20%20%7D%5Cn%20%20%20%20%7D%2C%5Cn%20%20%20%20%5C%22items%5C%22%3A%20%5B%5Cn%20%20%20%20%20%20%7B%5Cn%20%20%20%20%20%20%20%20%5C%22id%5C%22%3A%20%5C%22132981%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22name%5C%22%3A%20%5C%22Some%20useful%20product%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22price%5C%22%3A%2020.51%2C%5Cn%20%20%20%20%20%20%20%20%5C%22quantity%5C%22%3A%202%2C%5Cn%20%20%20%20%20%20%20%20%5C%22deliveryType%5C%22%3A%20%5C%22Normal%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22deliverySlaInMinutes%5C%22%3A%204320%2C%5Cn%20%20%20%20%20%20%20%20%5C%22categoryId%5C%22%3A%20%5C%22111%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22categoryName%5C%22%3A%20%5C%22Electronica%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22discount%5C%22%3A%201.99%2C%5Cn%20%20%20%20%20%20%20%20%5C%22sellerId%5C%22%3A%20%5C%22vtexargentina%5C%22%5Cn%20%20%20%20%20%20%7D%2C%5Cn%20%20%20%20%20%20%7B%5Cn%20%20%20%20%20%20%20%20%5C%22id%5C%22%3A%20%5C%22123242%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22name%5C%22%3A%20%5C%22Some%20useless%20product%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22price%5C%22%3A%2021.98%2C%5Cn%20%20%20%20%20%20%20%20%5C%22quantity%5C%22%3A%201%2C%5Cn%20%20%20%20%20%20%20%20%5C%22deliveryType%5C%22%3A%20%5C%22Normal%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22deliverySlaInMinutes%5C%22%3A%204320%2C%5Cn%20%20%20%20%20%20%20%20%5C%22categoryId%5C%22%3A%20%5C%22123%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22categoryName%5C%22%3A%20%5C%22Lar%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22discount%5C%22%3A%201.01%2C%5Cn%20%20%20%20%20%20%20%20%5C%22sellerId%5C%22%3A%20%5C%22vtexargentina%5C%22%5Cn%20%20%20%20%20%20%7D%5Cn%20%20%20%20%5D%2C%5Cn%20%20%20%20%5C%22taxValue%5C%22%3A%205.58%2C%5Cn%20%20%20%20%5C%22listRegistry%5C%22%3A%20%7B%5Cn%20%20%20%20%20%20%5C%22name%5C%22%3A%20%5C%22Minha%20lista%20Presente%5C%22%2C%5Cn%20%20%20%20%20%20%5C%22deliveryToOwner%5C%22%3A%20false%5Cn%20%20%20%20%7D%5Cn%20%20%7D%2C%5Cn%20%20%5C%22payments%5C%22%3A%20%5B%5Cn%20%20%20%20%7B%5Cn%20%20%20%20%20%20%5C%22id%5C%22%3A%20%5C%222D00FEBB5D7A43D598A99CFC43ADF158%5C%22%2C%5Cn%20%20%20%20%20%20%5C%22method%5C%22%3A%20%5C%22CreditCard%5C%22%2C%5Cn%20%20%20%20%20%20%5C%22name%5C%22%3A%20%5C%22Visa%5C%22%2C%5Cn%20%20%20%20%20%20%5C%22value%5C%22%3A%2063.98%2C%5Cn%20%20%20%20%20%20%5C%22installments%5C%22%3A%203%2C%5Cn%20%20%20%20%20%20%5C%22details%5C%22%3A%20%7B%5Cn%20%20%20%20%20%20%20%20%5C%22bin%5C%22%3A%20%5C%22507860%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22lastDigits%5C%22%3A%20%5C%222798%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22holder%5C%22%3A%20%5C%22John%20Doe%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%5C%22address%5C%22%3A%20%7B%5Cn%20%20%20%20%20%20%20%20%20%20%5C%22country%5C%22%3A%20%5C%22BRA%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%20%20%5C%22street%5C%22%3A%20%5C%22Rua%20Praia%20de%20Botafogo%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%20%20%5C%22number%5C%22%3A%20%5C%22518%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%20%20%5C%22complement%5C%22%3A%20%5C%222o.%20andar%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%20%20%5C%22neighborhood%5C%22%3A%20%5C%22Botafogo%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%20%20%5C%22postalCode%5C%22%3A%20%5C%2222250-040%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%20%20%5C%22city%5C%22%3A%20%5C%22Rio%20de%20Janeiro%5C%22%2C%5Cn%20%20%20%20%20%20%20%20%20%20%5C%22state%5C%22%3A%20%5C%22RJ%5C%22%5Cn%20%20%20%20%20%20%20%20%7D%5Cn%20%20%20%20%20%20%7D%5Cn%20%20%20%20%20%5C%22currencyIso4217%5C%22%3A%20%5C%22BRL%5C%22%5Cn%20%20%20%20%7D%2C%5Cn%20%20%20%20%7B%5Cn%20%20%20%20%20%20%5C%22id%5C%22%3A%20%5C%2204D430E517B2494FBC3DF7721CCDACC7%5C%22%2C%5Cn%20%20%20%20%20%20%5C%22method%5C%22%3A%20%5C%22GiftCard%5C%22%2C%5Cn%20%20%20%20%20%20%5C%22value%5C%22%3A%2010.01%2C%5Cn%20%20%20%20%20%20%5C%22installments%5C%22%3A%201%5Cn%20%20%20%20%7D%5Cn%20%20%5D%2C%5Cn%20%20%5C%22hook%5C%22%3A%20%5C%22https%3A%2F%2Fhook.vtex%2Ccom%2FnotifyIfChangeStatus%5C%22%2C%5Cn%20%20%5C%22transactionStartDate%5C%22%3A%20%5C%222020-10-30T18%3A08%3A23Z%5C%22%5Cn%7D'%22%2C%22language%22%3A%22curl%22%7D%5D%7D[/block]\n\n[block:code]%7B%22codes%22%3A%5B%7B%22code%22%3A%22this%20is%20a%20readme%20code%20block%22%2C%22language%22%3A%22text%22%7D%2C%7B%22code%22%3A%22%7B%5Cn%20%20%20%20%5C%22value%5C%22%3A%20%5C%22%7B%5C%5C%5C%22Phones%5C%5C%5C%22%3A%5B%5C%5C%5C%2255555555%5C%5C%5C%22%5D%7D%5C%22%5Cn%20%20%7D%22%2C%22language%22%3A%22json%22%7D%5D%7D[/block]\n\n#### These are callout magic blocks\n\n[block:callout]%7B%22type%22%3A%22info%22%2C%22title%22%3A%22This%20is%20a%20title%22%2C%22body%22%3A%22This%20an%20information%20callout%22%7D[/block]\n\n[block:callout]%7B%22type%22%3A%22warning%22%2C%22title%22%3A%22This%20is%20a%20title%22%2C%22body%22%3A%22This%20a%20warning%20callout%22%7D[/block]\n\n[block:callout]%7B%22type%22%3A%22danger%22%2C%22title%22%3A%22This%20is%20a%20title%22%2C%22body%22%3A%22This%20a%20danger%20callout%22%7D[/block]\n\n[block:callout]%7B%22type%22%3A%22success%22%2C%22title%22%3A%22This%20is%20a%20title%22%2C%22body%22%3A%22This%20a%20success%20callout%22%7D[/block]\n\n#### This is a magic block table\n\n[block:parameters]%7B%22data%22%3A%7B%220-0%22%3A%22Cell%22%2C%220-1%22%3A%22Cell%22%2C%220-2%22%3A%22Cell%22%2C%221-0%22%3A%22Cell%22%2C%221-1%22%3A%22Cell%22%2C%221-2%22%3A%22Cell%22%2C%22h-0%22%3A%22Column%20Title%22%2C%22h-1%22%3A%22Column%20Title%22%2C%22h-2%22%3A%22Column%20Title%22%7D%2C%22cols%22%3A3%2C%22rows%22%3A2%7D[/block]\n\n#### This is a html magic block\n\n[block:html]%7B%22html%22%3A%22%3Cdiv%20class%3D%5C%22test%5C%22%3EA%20Custom%20HTML%20block%3C%2Fdiv%3E%5Cn%5Cn%3Cstyle%3E%5Cn.test%7B%5Cn%20%20color%3A%20red%5Cn%7D%5Cn%3C%2Fstyle%3E%22%7D[/block]\n\n#### This is a image magic block\n\n[block:image]%7B%22images%22%3A%5B%7B%22image%22%3A%5B%22https%3A%2F%2Ffiles.readme.io%2F7292034-Arquitetura_IO.png%22%2C%22Arquitetura%20IO.png%22%2C1191%2C1064%2C%22%23000000%22%5D%2C%22caption%22%3A%22A%20Readme%20image%20with%20caption%22%7D%5D%7D[/block]\n\n#### These are embed magic blocks\n\n[block:embed]%7B%22html%22%3A%22%3Ciframe%20width%3D%5C%22100%25%5C%22%20height%3D%5C%22300%5C%22%20src%3D%5C%22%2F%2Fjsfiddle.net%2Fafabbro%2FvrVAP%2Fembedded%2F%5C%22%20allowfullscreen%3D%5C%22allowfullscreen%5C%22%20allowpaymentrequest%20frameborder%3D%5C%220%5C%22%3E%3C%2Fiframe%3E%22%2C%22url%22%3A%22https%3A%2F%2Fjsfiddle.net%2Fafabbro%2FvrVAP%2F%22%2C%22title%22%3A%22JSFiddle%22%2C%22favicon%22%3A%22https%3A%2F%2Fjsfiddle.net%2Fimg%2Ffavicon.png%22%2C%22image%22%3A%22https%3A%2F%2Fwww.gravatar.com%2Favatar%2F32ab7c2e34fa4afa320ad325c2aa38df%3Fs%3D80%22%2C%22provider%22%3A%22http%3A%2F%2Fjsfiddle.net%22%2C%22href%22%3A%22https%3A%2F%2Fjsfiddle.net%2Fafabbro%2FvrVAP%2F%22%2C%22typeOfEmbed%22%3A%22jsfiddle%22%7D[/block]\n\n[block:embed]%7B%22html%22%3A%22%3Ciframe%20width%3D%5C%22560%5C%22%20height%3D%5C%22315%5C%22%20src%3D%5C%22https%3A%2F%2Fwww.youtube.com%2Fembed%2FcJu9kMrA9I4%5C%22%20title%3D%5C%22YouTube%20video%20player%5C%22%20frameborder%3D%5C%220%5C%22%20allow%3D%5C%22accelerometer%3B%20autoplay%3B%20clipboard-write%3B%20encrypted-media%3B%20gyroscope%3B%20picture-in-picture%5C%22%20allowfullscreen%3E%3C%2Fiframe%3E%22%2C%22url%22%3A%22https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DcJu9kMrA9I4%22%2C%22title%22%3A%22O%20que%20%C3%A9%20VTEX%3F%22%2C%22favicon%22%3A%22https%3A%2F%2Fwww.google.com%2Ffavicon.ico%22%2C%22image%22%3A%22https%3A%2F%2Fi.ytimg.com%2Fvi%2FcJu9kMrA9I4%2Fhqdefault.jpg%22%2C%22provider%22%3A%22https%3A%2F%2Fwww.youtube.com%2F%22%2C%22href%22%3A%22https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DcJu9kMrA9I4%22%2C%22typeOfEmbed%22%3A%22youtube%22%7D[/block]\n\n", - "operationId": "ProductAndSkuIds", - "parameters": [ - { - "name": "categoryId", - "in": "query", - "description": "Fill this variable with the category ID that you need retrieves Product and SKU", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 1 - } - }, - { - "name": "_from", - "in": "query", - "description": "Insert the number that will start the request result", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 1 - } - }, - { - "name": "_to", - "in": "query", - "description": "Insert the number that will end the request result", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 10 - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK", - "headers": {}, - "content": { - "application/json": { - "example": { - "data": { - "3": [ - 5 - ], - "8": [ - 310118453, - 310118459, - 310118463 - ], - "2": [ - 3, - 310118450, - 310118451, - 4, - 8 - ], - "9": [ - 310118454, - 310118455, - 310118456, - 310118457, - 310118458, - 310118460, - 310118461, - 310118462, - 310118464 - ], - "12": [ - 310118490 - ], - "6": [], - "7": [ - 310118452 - ], - "1": [ - 1, - 123456, - 310118449, - 310118489, - 7, - 2 - ], - "5": [ - 310118465 - ], - "4": [ - 310118448 - ], - "10": [], - "11": [] - }, - "range": { - "total": 12, - "from": 1, - "to": 20 - } - }, - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Object compose by Product IDs and SKU IDs, where the parent ID is from Products and the SKU IDs are the Child IDs.", - "properties": { - "Product ID": { - "type": "array", - "description": "Array with SKU IDs of a certain product.", - "properties": { - "SKU ID": { - "type": "integer", - "description": "Product SKU ID." - } - } - } - } - }, - "range": { - "type": "object", - "description": "Object with information about the product and SKUs list.", - "properties": { - "total": { - "type": "integer", - "description": "Total quantity of SKUs." - }, - "from": { - "type": "integer", - "description": "Initial product ID." - }, - "to": { - "type": "integer", - "description": "Final product ID." - } - } - } - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/product/{productId}": { - "get": { - "tags": [ - "Product" - ], - "summary": "Get Product by ID", - "description": "Retrieves a specific Product by its ID. This information is exactly what is needed to create a new Product.", - "operationId": "GetProductbyid", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "description": "Product’s unique numerical identifier", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "example": { - "Id": 42, - "Name": "Zoom Stefan Janoski Canvas RM SB Varsity Red", - "DepartmentId": 2000089, - "CategoryId": 2000090, - "BrandId": 12121219, - "LinkId": "stefan-janoski-canvas-varsity-red", - "RefId": "sr_1_90", - "IsVisible": true, - "Description": "The Nike Zoom Stefan Janoski Men's Shoe is made with a premium leather upper for superior durability and a flexible midsole for all-day comfort. A tacky gum rubber outsole delivers outstanding traction.", - "DescriptionShort": "The Nike Zoom Stefan Janoski is made with a premium leather.", - "ReleaseDate": "2020-01-01T00:00:00", - "KeyWords": "Zoom,Stefan,Janoski", - "Title": "Zoom Stefan Janoski Canvas RM SB Varsity Re", - "IsActive": true, - "TaxCode": "", - "MetaTagDescription": "The Nike Zoom Stefan Janoski Men's Shoe is made with a premium leather upper for superior durability and a flexible midsole for all-day comfort. A tacky gum rubber outsole delivers outstanding traction.", - "SupplierId": 1, - "ShowWithoutStock": true, - "AdWordsRemarketingCode": "", - "LomadeeCampaignCode": "", - "Score": 1 - }, - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "Product’s unique numerical identifier." - }, - "Name": { - "type": "string", - "description": "Product's name." - }, - "DepartmentId": { - "type": "integer", - "description": "Department ID according to the product's category. This field should not be provided during product creation." - }, - "CategoryId": { - "type": "integer", - "description": "Category ID associated with this product." - }, - "BrandId": { - "type": "integer", - "description": "Brand ID associated with this product." - }, - "LinkId": { - "type": "string", - "description": "String to be used to build the product URL. If it not informed, it will be generated according to product's name replacing space and special character by hifen (-)." - }, - "RefId": { - "type": "string", - "description": "Product Reference Code." - }, - "IsVisible": { - "type": "boolean", - "description": "Show (`true`) or hide (`false`) product in search result and product page but can be added into shopping cart. Usually applicable for gifts." - }, - "Description": { - "type": "string", - "description": "Product description." - }, - "DescriptionShort": { - "type": "string", - "description": "Product Short description. This information is presented by:\r\nStore Framework: `$product.DescriptionShort` control. And can be displayed on both the product page and the shelf.\r\n" - }, - "ReleaseDate": { - "type": "string", - "description": "Used to assist in the ordering of the search result of the site. Using the `O=OrderByReleaseDateDESC` querystring, you can pull this value and show the display order by release date. This attribute is also used as a condition for dynamic collections." - }, - "KeyWords": { - "type": "string", - "description": "Store Framework: Deprecated\r\nClassic CMS: Synonyms of terms related to product. \"Television\", for example, can have a substitute word like \"TV\". This field is important to make your searches more comprehensive.\r\n" - }, - "Title": { - "type": "string", - "description": "Product's Title tag. Is presented in the browser tab and corresponds to the title of the product page. This field is important for SEO." - }, - "IsActive": { - "type": "boolean", - "description": "Activate (`true`) or inactivate (`false`) product." - }, - "TaxCode": { - "type": "string", - "description": "Product fiscal number. Usually used for tax calculation." - }, - "MetaTagDescription": { - "type": "string", - "description": "Brief description of the product for SEO. It's recommended that you don't exceed 150 characters." - }, - "SupplierId": { - "type": "integer", - "deprecated": true, - "nullable": true - }, - "ShowWithoutStock": { - "type": "boolean", - "description": "If `true`, activates `Notify Me` form when the product is out of stock." - }, - "AdWordsRemarketingCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "LomadeeCampaignCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "Score": { - "type": "integer", - "description": "Value used to set the priority on the search result page.", - "example": 1 - } - } - } - } - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Product" - ], - "summary": "Update Product", - "description": "Updates an existent Product", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "required": true, - "description": "Product’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "example": { - "Id": 42, - "Name": "Zoom Stefan Janoski Canvas RM SB Varsity Red", - "DepartmentId": 2000089, - "CategoryId": 2000090, - "BrandId": 12121219, - "LinkId": "stefan-janoski-canvas-varsity-red", - "RefId": "sr_1_90", - "IsVisible": true, - "Description": "The Nike Zoom Stefan Janoski Men's Shoe is made with a premium leather upper for superior durability and a flexible midsole for all-day comfort. A tacky gum rubber outsole delivers outstanding traction.", - "DescriptionShort": "The Nike Zoom Stefan Janoski is made with a premium leather.", - "ReleaseDate": "2020-01-01T00:00:00", - "KeyWords": "Zoom,Stefan,Janoski", - "Title": "Zoom Stefan Janoski Canvas RM SB Varsity Re", - "IsActive": true, - "TaxCode": "", - "MetaTagDescription": "The Nike Zoom Stefan Janoski Men's Shoe is made with a premium leather upper for superior durability and a flexible midsole for all-day comfort. A tacky gum rubber outsole delivers outstanding traction.", - "SupplierId": 1, - "ShowWithoutStock": true, - "AdWordsRemarketingCode": "", - "LomadeeCampaignCode": "", - "Score": 1 - }, - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "Product’s unique numerical identifier." - }, - "Name": { - "type": "string", - "description": "Product's name." - }, - "DepartmentId": { - "type": "integer", - "description": "Department ID according to the product's category. This field should not be provided during product creation." - }, - "CategoryId": { - "type": "integer", - "description": "Category ID associated with this product." - }, - "BrandId": { - "type": "integer", - "description": "Brand ID associated with this product." - }, - "LinkId": { - "type": "string", - "description": "String to be used to build the product URL. If it not informed, it will be generated according to product's name replacing space and special character by hifen (-)." - }, - "RefId": { - "type": "string", - "description": "Product Reference Code." - }, - "IsVisible": { - "type": "boolean", - "description": "Show (`true`) or hide (`false`) product in search result and product page but can be added into shopping cart. Usually applicable for gifts." - }, - "Description": { - "type": "string", - "description": "Product description." - }, - "DescriptionShort": { - "type": "string", - "title": "DescriptionShort", - "description": "Product Short description. This information is presented by:\r\nStore Framework: $product.DescriptionShort control\r\nClassic CMS: \r\nAnd can be displayed on both the product page and the shelf.\r\n" - }, - "ReleaseDate": { - "type": "string", - "description": "Used to assist in the ordering of the search result of the site. Using the `O=OrderByReleaseDateDESC` querystring, you can pull this value and show the display order by release date. This attribute is also used as a condition for dynamic collections." - }, - "KeyWords": { - "type": "string", - "description": "Store Framework: Deprecated\r\nClassic CMS: Synonyms of terms related to product. \"Television\", for example, can have a substitute word like \"TV\". This field is important to make your searches more comprehensive.\r\n" - }, - "Title": { - "type": "string", - "description": "Product's Title tag. Is presented in the browser tab and corresponds to the title of the product page. This field is important for SEO." - }, - "IsActive": { - "type": "boolean", - "description": "Activate (`true`) or inactivate (`false`) product." - }, - "TaxCode": { - "type": "string", - "description": "Product fiscal number. Usually used for tax calculation." - }, - "MetaTagDescription": { - "type": "string", - "description": "Brief description of the product for SEO. It's recommended that you don't exceed 150 characters." - }, - "SupplierId": { - "type": "integer", - "deprecated": true, - "nullable": true - }, - "ShowWithoutStock": { - "type": "boolean", - "description": "If `true`, activates `Notify Me` form when the product is out of stock." - }, - "AdWordsRemarketingCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "LomadeeCampaignCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "Score": { - "type": "integer", - "description": "Value used to set the priority on the search result page." - } - } - } - } - } - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "Name", - "CategoryId", - "BrandId" - ], - "properties": { - "Name": { - "type": "string", - "title": "Name", - "description": "Product's name.", - "example": "Zoom Stefan Janoski Canvas RM SB Varsity Red" - }, - "DepartmentId": { - "type": "integer", - "title": "DepartmentId", - "description": "Department ID according to the product's category. This field should not be provided during product creation.", - "example": 2000089 - }, - "CategoryId": { - "type": "integer", - "title": "CategoryId", - "description": "Category ID associated with this product.", - "example": 2000090 - }, - "BrandId": { - "type": "integer", - "title": "BrandId", - "description": "Brand ID associated with this product.", - "example": 12121219 - }, - "LinkId": { - "type": "string", - "title": "LinkId", - "description": "String to be used to build the product URL. If it not informed, it will be generated according to product's name replacing space and special character by hifen (-).", - "example": "stefan-janoski-canvas-varsity-red" - }, - "RefId": { - "type": "string", - "title": "RefId", - "description": "Product Reference Code.", - "example": "sr_1_90" - }, - "IsVisible": { - "type": "boolean", - "title": "IsVisible", - "description": "Show (`true`) or hide (`false`) product in search result and product page but can be added into shopping cart. Usually applicable for gifts.", - "example": true - }, - "Description": { - "type": "string", - "title": "Description", - "description": "Product description.", - "example": "The Nike Zoom Stefan Janoski Men's Shoe is made with a premium leather upper for superior durability and a flexible midsole for all-day comfort. A tacky gum rubber outsole delivers outstanding traction." - }, - "DescriptionShort": { - "type": "string", - "title": "DescriptionShort", - "description": "Product Short description. This information is presented by:\r\nStore Framework: $product.DescriptionShort control\r\nClassic CMS: \r\nAnd can be displayed on both the product page and the shelf.\r\n", - "example": "The Nike Zoom Stefan Janoski is made with a premium leather." - }, - "ReleaseDate": { - "type": "string", - "title": "ReleaseDate", - "description": "Used to assist in the ordering of the search result of the site. Using the `O=OrderByReleaseDateDESC` querystring, you can pull this value and show the display order by release date. This attribute is also used as a condition for dynamic collections.", - "example": "2019-01-01T00:00:00" - }, - "KeyWords": { - "type": "string", - "title": "KeyWords", - "description": "Store Framework: Deprecated\r\nClassic CMS: Synonyms of terms related to product. \"Television\", for example, can have a substitute word like \"TV\". This field is important to make your searches more comprehensive.\r\n", - "example": "Zoom,Stefan,Janoski" - }, - "Title": { - "type": "string", - "title": "Title", - "description": "Product's Title tag. Is presented in the browser tab and corresponds to the title of the product page. This field is important for SEO.", - "example": "Zoom Stefan Janoski Canvas RM SB Varsity Red" - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "Activate (`true`) or inactivate (`false`) product.", - "example": true - }, - "TaxCode": { - "type": "string", - "title": "TaxCode", - "description": "Product fiscal number. Usually used for tax calculation.", - "example": "12345" - }, - "MetaTagDescription": { - "type": "string", - "title": "MetaTagDescription", - "description": "Brief description of the product for SEO. It's recommended that you don't exceed 150 characters.", - "example": "The Nike Zoom Stefan Janoski Men's Shoe is made with a premium leather upper for superior durability and a flexible midsole for all-day comfort. A tacky gum rubber outsole delivers outstanding traction." - }, - "SupplierId": { - "type": "integer", - "deprecated": true, - "nullable": true - }, - "ShowWithoutStock": { - "type": "boolean", - "title": "ShowWithoutStock", - "description": "If `true`, activates `Notify Me` form when the product is out of stock.", - "example": true - }, - "AdWordsRemarketingCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "LomadeeCampaignCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "Score": { - "type": "integer", - "title": "Score", - "description": "Value used to set the priority on the search result page.", - "example": 1 - } - } - } - } - } - } - } - }, - "/api/catalog_system/pvt/products/productget/{productId}": { - "get": { - "tags": [ - "Product" - ], - "summary": "Get Product and its general context", - "description": "Retrieves a specific product's general information as name, description and the trade policies that it is included.", - "operationId": "ProductandTradePolicy", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "description": "Product’s unique numerical identifier", - "required": true, - "style": "simple", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK", - "headers": {}, - "content": { - "application/json": { - "example": { - "Id": 1, - "Name": "Ração Royal Canin Feline Urinary", - "DepartmentId": 1, - "CategoryId": 10, - "BrandId": 2000000, - "LinkId": "racao-royal-canin-feline-urinary", - "RefId": "", - "IsVisible": true, - "Description": "Descrição.", - "DescriptionShort": "", - "ReleaseDate": "2020-01-06T00:00:00", - "KeyWords": "bbbbbbbbbbbb*, a@", - "Title": "Ração Royal Canin Feline Urinary", - "IsActive": true, - "TaxCode": "", - "MetaTagDescription": "Descrição.", - "SupplierId": 1, - "ShowWithoutStock": true, - "ListStoreId": [ - 1, - 2, - 3 - ], - "AdWordsRemarketingCode": "", - "LomadeeCampaignCode": "" - }, - "schema": { - "type": "object", - "title": "", - "properties": { - "Id": { - "type": "integer", - "title": "Id", - "description": "Product ID.", - "default": 1 - }, - "Name": { - "type": "string", - "title": "Name", - "description": "Product name.", - "default": "Ração Royal Canin Feline Urinary" - }, - "DepartmentId": { - "type": "integer", - "title": "DepartmentId", - "description": "Product department ID.", - "default": 1 - }, - "CategoryId": { - "type": "integer", - "title": "CategoryId", - "description": "Product category ID.", - "default": 10 - }, - "BrandId": { - "type": "integer", - "title": "BrandId", - "description": "Product brand ID.", - "default": 2000000 - }, - "LinkId": { - "type": "string", - "title": "LinkId", - "description": "Product text link.", - "default": "racao-royal-canin-feline-urinary" - }, - "RefId": { - "type": "string", - "title": "RefId", - "description": "Product referecial code.", - "default": "" - }, - "IsVisible": { - "type": "boolean", - "title": "IsVisible", - "description": "If the Product is visible on the store.", - "default": true - }, - "Description": { - "type": "string", - "title": "Description", - "description": "Product description.", - "default": "Description" - }, - "DescriptionShort": { - "type": "string", - "title": "DescriptionShort", - "description": "Product complement name.", - "default": "" - }, - "ReleaseDate": { - "type": "string", - "title": "ReleaseDate", - "description": "Product release date.", - "default": "2020-01-06T00:00:00" - }, - "KeyWords": { - "type": "string", - "title": "KeyWords", - "description": "Substitutes words for the product.", - "default": "ração, racao, animal" - }, - "Title": { - "type": "string", - "title": "Title", - "description": "Product tag title.", - "default": "Ração Royal Canin Feline Urinary" - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "If the product is active (`true`) or not (`false`) at the store.", - "default": true - }, - "TaxCode": { - "type": "string", - "title": "TaxCode", - "description": "Product fiscal code.", - "default": "" - }, - "MetaTagDescription": { - "type": "string", - "title": "MetaTagDescription", - "description": "Product meta tag description.", - "default": "Description" - }, - "SupplierId": { - "type": "integer", - "title": "SupplierId", - "description": "Product supplier ID.", - "default": 1 - }, - "ShowWithoutStock": { - "type": "boolean", - "title": "ShowWithoutStock", - "description": "Defines if the Product will remain being shown in the store even if it’s out of stock.", - "default": true - }, - "ListStoreId": { - "type": "array", - "title": "ListStoreId", - "description": "List with the Trade Policies IDs that the product is included.", - "default": [ - 1, - 2 - ] - }, - "AdWordsRemarketingCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "LomadeeCampaignCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - } - } - } - } - } - } - } - } - }, - "/api/catalog_system/pvt/products/productgetbyrefid/{refId}": { - "get": { - "tags": [ - "Product" - ], - "summary": "Get Product by RefId", - "description": "Retrieves a specific product by its Reference ID.", - "operationId": "ProductbyRefId", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "refId", - "in": "path", - "description": "Product Referecial Code", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "headers": {}, - "content": { - "application/json": { - "example": { - "Id": 17, - "Name": "BLACK+DECKER 20V MAX Cordless Drill / Driver with 30-Piece Accessories (LD120VA)", - "DepartmentId": 9287, - "CategoryId": 9287, - "BrandId": 9280, - "LinkId": "black-decker-20v-max-cordless-drill-driver-with-30-piece-acessories-ld120va", - "RefId": "880010", - "IsVisible": true, - "Description": "The Black and Decker LD120-VoltA 20-Volt Max Lithium Drill/Driver with 30 Accessories come with the Black and Decker 20-volt max Lithium Ion Battery. These batteries are always ready, holding a charge up to 18 months. This drill provides an extra level of control with a 24 position clutch that helps to prevent stripping and overdriving screws. It has a soft grip handle that provides added comfort during use and a light weight to prevent user fatigue. This drill is ideal for drilling and screwdriving through wood, metal, and plastic. The LD120-VoltA set includes: LD120 20-Volt MAX Lithium Drill/Driver, (1) LB20 20-Volt MAX Lithium Ion Battery, (1) LCS20 Charger, (6) Brad Point Drill Bits, (10) 1-Inch Screwdriving Bits, (9) 2-Inch Screwdriving Bits, (4) Nut Drivers, (1) Magnetic Bit Tip Holder and is backed by Black and Decker's 2 year limited warranty.", - "DescriptionShort": "The Black and Decker LD120-VoltA 20-Volt Max Lithium Drill/Driver with 30 Accessories come with the Black and Decker 20-volt max Lithium Ion Battery. These batteries are always ready, holding a charge up to 18 months. This drill provides an extra level of control with a 24 position clutch that helps to prevent stripping and overdriving screws. It has a soft grip handle that provides added comfort during use and a light weight to prevent user fatigue. This drill is ideal for drilling and screwdriving through wood, metal, and plastic. The LD120-VoltA set includes: LD120 20-Volt MAX Lithium Drill/Driver, (1) LB20 20-Volt MAX Lithium Ion Battery, (1) LCS20 Charger, (6) Brad Point Drill Bits, (10) 1-Inch Screwdriving Bits, (9) 2-Inch Screwdriving Bits, (4) Nut Drivers, (1) Magnetic Bit Tip Holder and is backed by Black and Decker's 2 year limited warranty.", - "ReleaseDate": "2020-01-01T00:00:00", - "KeyWords": "product,sample", - "Title": "BLACK+DECKER 20V MAX Cordless Drill / Driver with 30-Piece Accessories (LD120VA)", - "IsActive": true, - "TaxCode": "", - "MetaTagDescription": "The Black and Decker LD120-VoltA 20-Volt Max Lithium Drill/Driver with 30 Accessories come with the Black and Decker 20-volt max Lithium Ion Battery. These batteries are always ready, holding a charge up to 18 months. This drill provides an extra level of control with a 24 position clutch that helps to prevent stripping and overdriving screws. It has a soft grip handle that provides added comfort during use and a light weight to prevent user fatigue. This drill is ideal for drilling and screwdriving through wood, metal, and plastic. The LD120-VoltA set includes: LD120 20-Volt MAX Lithium Drill/Driver, (1) LB20 20-Volt MAX Lithium Ion Battery, (1) LCS20 Charger, (6) Brad Point Drill Bits, (10) 1-Inch Screwdriving Bits, (9) 2-Inch Screwdriving Bits, (4) Nut Drivers, (1) Magnetic Bit Tip Holder and is backed by Black and Decker's 2 year limited warranty.", - "SupplierId": 1, - "ShowWithoutStock": true, - "ListStoreId": [ - 1 - ], - "AdWordsRemarketingCode": "", - "LomadeeCampaignCode": "" - }, - "schema": { - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "ID of the Product." - }, - "Name": { - "type": "string", - "description": "Name of the Product." - }, - "DepartmentId": { - "type": "integer", - "description": "ID of product department." - }, - "CategoryId": { - "type": "integer", - "description": "ID of product Category." - }, - "BrandId": { - "type": "integer", - "description": "ID of the product Brand." - }, - "LinkId": { - "type": "string", - "description": "Category URL." - }, - "RefId": { - "type": "string", - "description": "Product Reference ID." - }, - "IsVisible": { - "type": "boolean", - "description": "If the product are visible in search and list pages." - }, - "Description": { - "type": "string", - "description": "Product Description, HTML is allowed." - }, - "DescriptionShort": { - "type": "string", - "description": "Product Short Description." - }, - "ReleaseDate": { - "type": "string", - "description": "Product Release Date, for list ordering and product cluster highlight." - }, - "KeyWords": { - "type": "string", - "description": "Alternatives Keywords to improve the product findability." - }, - "Title": { - "type": "string", - "description": "Meta Title for the Product page." - }, - "IsActive": { - "type": "boolean", - "description": "If the product is Active." - }, - "TaxCode": { - "type": "string", - "description": "SKU Tax Code." - }, - "MetaTagDescription": { - "type": "string", - "description": "Meta Description for the Product page." - }, - "SupplierId": { - "type": "integer", - "description": "Product Supplier ID." - }, - "ShowWithoutStock": { - "type": "boolean", - "description": "If the product can be visible without stock." - }, - "ListStoreId": { - "type": "array", - "description": "Array with the ID of all the trade policies that are related to the product.", - "items": { - "type": "integer", - "description": "Trade policy ID." - } - }, - "AdWordsRemarketingCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "LomadeeCampaignCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - } - } - } - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pub/products/variations/{productId}": { - "get": { - "tags": [ - "Product" - ], - "summary": "Get Product's SKUs by Product ID", - "description": "Retrieves data about the product and all SKUs related to it by the product's ID.", - "operationId": "ProductVariations", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "description": "Product’s unique numerical identifier", - "required": true, - "style": "simple", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {} - } - }, - "deprecated": false - } - }, - "/api/addon/pvt/review/GetProductRate/{productId}": { - "get": { - "tags": [ - "Product" - ], - "summary": "Get Product Review Rate by Product ID", - "description": "Retrieves the review rate of a product by this product's ID.", - "operationId": "ReviewRateProduct", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "description": "Product’s unique numerical identifier", - "required": true, - "style": "simple", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK", - "headers": {}, - "content": { - "application/json": { - "schema": { - "example": 3.0, - "type": "number", - "description": "Review rate numeber." - } - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog/pvt/product": { - "post": { - "tags": [ - "Product" - ], - "summary": "Create Product", - "description": "Creates a new Product from scratch", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "example": { - "Id": 42, - "Name": "Zoom Stefan Janoski Canvas RM SB Varsity Red", - "DepartmentId": 2000089, - "CategoryId": 2000090, - "BrandId": 12121219, - "LinkId": "stefan-janoski-canvas-varsity-red", - "RefId": "sr_1_90", - "IsVisible": true, - "Description": "The Nike Zoom Stefan Janoski Men's Shoe is made with a premium leather upper for superior durability and a flexible midsole for all-day comfort. A tacky gum rubber outsole delivers outstanding traction.", - "DescriptionShort": "The Nike Zoom Stefan Janoski is made with a premium leather.", - "ReleaseDate": "2020-01-01T00:00:00", - "KeyWords": "Zoom,Stefan,Janoski", - "Title": "Zoom Stefan Janoski Canvas RM SB Varsity Re", - "IsActive": true, - "TaxCode": "", - "MetaTagDescription": "The Nike Zoom Stefan Janoski Men's Shoe is made with a premium leather upper for superior durability and a flexible midsole for all-day comfort. A tacky gum rubber outsole delivers outstanding traction.", - "SupplierId": 1, - "ShowWithoutStock": true, - "AdWordsRemarketingCode": "", - "LomadeeCampaignCode": "", - "Score": 1 - }, - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "Product’s unique numerical identifier." - }, - "Name": { - "type": "string", - "description": "Product's name." - }, - "DepartmentId": { - "type": "integer", - "description": "Department ID according to the product's category. This field should not be provided during product creation." - }, - "CategoryId": { - "type": "integer", - "description": "Category ID associated with this product." - }, - "BrandId": { - "type": "integer", - "description": "Brand ID associated with this product." - }, - "LinkId": { - "type": "string", - "description": "String to be used to build the product URL. If it not informed, it will be generated according to product's name replacing space and special character by hifen (-)." - }, - "RefId": { - "type": "string", - "description": "Product Reference Code." - }, - "IsVisible": { - "type": "boolean", - "description": "Show (`true`) or hide (`false`) product in search result and product page but can be added into shopping cart. Usually applicable for gifts." - }, - "Description": { - "type": "string", - "description": "Product description." - }, - "DescriptionShort": { - "type": "string", - "title": "DescriptionShort", - "description": "Product Short description. This information is presented by:\r\nStore Framework: $product.DescriptionShort control\r\nClassic CMS: \r\nAnd can be displayed on both the product page and the shelf.\r\n" - }, - "ReleaseDate": { - "type": "string", - "description": "Used to assist in the ordering of the search result of the site. Using the `O=OrderByReleaseDateDESC` querystring, you can pull this value and show the display order by release date. This attribute is also used as a condition for dynamic collections." - }, - "KeyWords": { - "type": "string", - "description": "Store Framework: Deprecated\r\nClassic CMS: Synonyms of terms related to product. \"Television\", for example, can have a substitute word like \"TV\". This field is important to make your searches more comprehensive.\r\n" - }, - "Title": { - "type": "string", - "description": "Product's Title tag. Is presented in the browser tab and corresponds to the title of the product page. This field is important for SEO." - }, - "IsActive": { - "type": "boolean", - "description": "Activate (`true`) or inactivate (`false`) product." - }, - "TaxCode": { - "type": "string", - "description": "Product fiscal number. Usually used for tax calculation." - }, - "MetaTagDescription": { - "type": "string", - "description": "Brief description of the product for SEO. It's recommended that you don't exceed 150 characters." - }, - "SupplierId": { - "type": "integer", - "deprecated": true, - "nullable": true - }, - "ShowWithoutStock": { - "type": "boolean", - "description": "If `true`, activates `Notify Me` form when the product is out of stock." - }, - "AdWordsRemarketingCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "LomadeeCampaignCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "Score": { - "type": "integer", - "description": "Value used to set the priority on the search result page." - } - } - } - } - } - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "Name", - "CategoryId", - "BrandId" - ], - "properties": { - "Name": { - "type": "string", - "title": "Name", - "description": "Product's name.", - "example": "Zoom Stefan Janoski Canvas RM SB Varsity Red" - }, - "DepartmentId": { - "type": "integer", - "title": "DepartmentId", - "description": "Department ID according to the product's category. This field should not be provided during product creation.", - "example": 2000089 - }, - "CategoryPath": { - "type": "string", - "description": "Categories's path associated with this product. This can replace the `CategoryId` field.", - "example": "Storage/Hard Drive" - }, - "CategoryId": { - "type": "integer", - "title": "CategoryId", - "description": "Category ID associated with this product.", - "example": 2000090 - }, - "BrandName": { - "type": "string", - "description": "Brand name associated with this product. This can replace the `BrandId` field.", - "example": "Sample Brand" - }, - "BrandId": { - "type": "integer", - "title": "BrandId", - "description": "Brand ID associated with this product.", - "example": 12121219 - }, - "LinkId": { - "type": "string", - "title": "LinkId", - "description": "String to be used to build the product URL. If it not informed, it will be generated according to product's name replacing space and special character by hifen (-).", - "example": "stefan-janoski-canvas-varsity-red" - }, - "RefId": { - "type": "string", - "title": "RefId", - "description": "Product Reference Code.", - "example": "sr_1_90" - }, - "IsVisible": { - "type": "boolean", - "title": "IsVisible", - "description": "Show (`true`) or hide (`false`) product in search result and product page but can be added into shopping cart. Usually applicable for gifts.", - "example": true - }, - "Description": { - "type": "string", - "title": "Description", - "description": "Product description.", - "example": "The Nike Zoom Stefan Janoski Men's Shoe is made with a premium leather upper for superior durability and a flexible midsole for all-day comfort. A tacky gum rubber outsole delivers outstanding traction." - }, - "DescriptionShort": { - "type": "string", - "title": "DescriptionShort", - "description": "Product Short description. This information is presented by:\r\nStore Framework: $product.DescriptionShort control\r\nClassic CMS: \r\nAnd can be displayed on both the product page and the shelf.\r\n", - "example": "The Nike Zoom Stefan Janoski is made with a premium leather." - }, - "ReleaseDate": { - "type": "string", - "title": "ReleaseDate", - "description": "Used to assist in the ordering of the search result of the site. Using the `O=OrderByReleaseDateDESC` querystring, you can pull this value and show the display order by release date. This attribute is also used as a condition for dynamic collections.", - "example": "2019-01-01T00:00:00" - }, - "KeyWords": { - "type": "string", - "title": "KeyWords", - "description": "Store Framework: Deprecated\r\nClassic CMS: Synonyms of terms related to product. \"Television\", for example, can have a substitute word like \"TV\". This field is important to make your searches more comprehensive.\r\n", - "example": "Zoom,Stefan,Janoski" - }, - "Title": { - "type": "string", - "title": "Title", - "description": "Product's Title tag. Is presented in the browser tab and corresponds to the title of the product page. This field is important for SEO.", - "example": "Zoom Stefan Janoski Canvas RM SB Varsity Red" - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "Activate (`true`) or inactivate (`false`) product.", - "example": true - }, - "TaxCode": { - "type": "string", - "title": "TaxCode", - "description": "Product fiscal number. Usually used for tax calculation.", - "example": "12345" - }, - "MetaTagDescription": { - "type": "string", - "title": "MetaTagDescription", - "description": "Brief description of the product for SEO. It's recommended that you don't exceed 150 characters.", - "example": "The Nike Zoom Stefan Janoski Men's Shoe is made with a premium leather upper for superior durability and a flexible midsole for all-day comfort. A tacky gum rubber outsole delivers outstanding traction." - }, - "SupplierId": { - "type": "integer", - "deprecated": true, - "nullable": true - }, - "ShowWithoutStock": { - "type": "boolean", - "title": "ShowWithoutStock", - "description": "If `true`, activates `Notify Me` form when the product is out of stock.", - "example": true - }, - "AdWordsRemarketingCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "LomadeeCampaignCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "Score": { - "type": "integer", - "title": "Score", - "description": "Value used to set the priority on the search result page.", - "example": 1 - } - } - } - } - } - } - } - }, - "/api/catalog_system/pvt/products/{productId}/specification": { - "get": { - "tags": [ - "Product Specification" - ], - "summary": "Get Product Specification by Product ID", - "description": "Retrieves all specifications of a product by the product's ID.", - "operationId": "GetProductSpecification", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "description": "Product’s unique numerical identifier", - "required": true, - "style": "simple", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "OK", - "headers": { - "Cache-Control": { - "content": { - "text/plain": { - "schema": { - "type": "string", - "example": "no-cache" - } - } - } - }, - "Content-Length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "102" - } - } - }, - "Date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Mon, 22 Jan 2018 23:18:18 GMT" - } - } - }, - "Expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-1" - } - } - }, - "Pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Microsoft-IIS/10.0" - } - } - }, - "X-AspNet-Version": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "4.0.30319" - } - } - }, - "X-Powered-By": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "ASP.NET" - } - } - }, - "no": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "CELOCOUTO" - } - } - }, - "p3p": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "policyref=\"/w3c/p3p.xml\",CP=\"ADMa OUR NOR CNT NID DSP NOI COR\"" - } - } - }, - "powered": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "vtex" - } - } - }, - "x-vtex-operation-id": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "7ec24c86-1dc8-4ec7-a4b7-79b06b53a742" - } - } - } - }, - "content": { - "application/json": { - "schema": { - "example": [ - { - "Value": [ - "Iron", - "Plastic" - ], - "Id": 30, - "Name": "Material" - }, - { - "Value": [ - "Bola4" - ], - "Id": 31, - "Name": "Nickname" - } - ], - "type": "array", - "items": { - "$ref": "#/components/schemas/Example2" - } - } - } - } - } - }, - "deprecated": false - }, - "post": { - "tags": [ - "Product Specification" - ], - "summary": "Update Product Specification by Product ID", - "description": "Updates the value of a product specification by the product's ID. The ID or name can be used to identify what product specification will be updated. Specification fields must be previously created in your Catalog.", - "operationId": "UpdateProductSpecification", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "description": "Product’s unique numerical identifier", - "required": true, - "style": "simple", - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "example": [ - { - "Value": [ - "Rubber", - "Plastic" - ], - "Id": 30 - }, - { - "Value": [ - "Giant" - ], - "Name": "Nickname" - } - ], - "type": "array", - "items": { - "$ref": "#/components/schemas/UpdateProductSpecificationRequest" - }, - "description": "" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK" - } - }, - "deprecated": false - } - }, - "/api/catalog/pvt/product/{productId}/specification": { - "get": { - "tags": [ - "Product Specification" - ], - "summary": "Get Product Specification and its information by Product ID", - "description": "Retrieves information of all specifications of a product by the product's ID.", - "operationId": "GetProductSpecificationbyProductID", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "description": "Product’s unique numerical identifier", - "required": true, - "style": "simple", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "title": "", - "example": [ - { - "Id": 227, - "ProductId": 1, - "FieldId": 33, - "FieldValueId": 135, - "Text": "ValueA" - }, - { - "Id": 228, - "ProductId": 1, - "FieldId": 34, - "FieldValueId": 1, - "Text": "Giant" - } - ], - "items": { - "type": "object", - "description": "Object with the product specification information.", - "properties": { - "Id": { - "type": "integer", - "description": "ID of the association of the specification and the product. This ID is used to update or delete the specification." - }, - "ProductId": { - "type": "integer", - "description": "Product ID." - }, - "FieldId": { - "type": "integer", - "description": "Specification ID." - }, - "FieldValueId": { - "type": "integer", - "description": "Current specification value ID." - }, - "Text": { - "type": "string", - "description": "Current specification value text." - } - } - } - } - } - } - } - }, - "deprecated": false - }, - "post": { - "tags": [ - "Product Specification" - ], - "summary": "Associate Product Specification", - "description": "Associates a previously defined Specification to a Product", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "required": true, - "description": "Product’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "example": { - "Id": 41, - "FieldId": 19, - "FieldValueId": 1, - "Text": "test" - }, - "type": "object", - "title": "", - "properties": { - "Id": { - "type": "integer", - "description": "ID of the association of the specification and the product. This ID is used to update or delete the specification." - }, - "ProductId": { - "type": "integer", - "description": "Product ID." - }, - "FieldId": { - "type": "integer", - "description": "Specification ID." - }, - "FieldValueId": { - "type": "integer", - "description": "Specification Value ID. Mandatory for `FieldTypeId` `5`, `6` and `7`. Must not be used for any other field types" - }, - "Text": { - "type": "string", - "description": "Value of specification. Only for `FieldTypeId` different from `5`, `6` and `7`." - } - } - } - } - } - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "FieldId" - ], - "properties": { - "FieldId": { - "type": "integer", - "title": "Fieldid", - "description": "Specification ID.", - "default": 19 - }, - "FieldValueId": { - "type": "integer", - "title": "Fieldvalueid", - "description": "Specification Value ID. Mandatory for `FieldTypeId` `5`, `6` and `7`. Must not be used for any other field types", - "default": 12 - }, - "Text": { - "type": "string", - "title": "Text", - "description": "Value of specification. Only for `FieldTypeId` different from `5`, `6` and `7`.", - "default": "Metal" - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "Product Specification" - ], - "summary": "Delete all Product Specification", - "description": "Deletes all Product Specifications", - "operationId": "DeleteAllProductSpecification", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "description": "Product’s unique numerical identifier", - "required": true, - "style": "simple", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/product/{productId}/specification/{specificationId}": { - "delete": { - "tags": [ - "Product Specification" - ], - "summary": "Delete Product Specification", - "description": "Deletes a specific Product Specification", - "operationId": "DeleteProductSpecification", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "description": "Product’s unique numerical identifier", - "required": true, - "style": "simple", - "schema": { - "type": "integer" - } - }, - { - "name": "specificationId", - "in": "path", - "description": "Product Specification’s unique numerical identifier", - "required": true, - "style": "simple", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/product/{productId}/specificationvalue": { - "put": { - "tags": [ - "Product Specification" - ], - "summary": "Associate product specification using specification and group names", - "description": "Associates a previously defined specification to a product using specification and group names", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "required": true, - "description": "Product’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "example": [ - { - "Id": 239, - "ProductId": 1, - "FieldId": 85, - "FieldValueId": 193, - "Text": "Value123" - } - ], - "type": "array", - "title": "", - "description": "Array with information of all product specifications.", - "items": { - "type": "object", - "description": "Object with information of the specification.", - "properties": { - "Id": { - "type": "integer", - "description": "ID of the association of the Product and the specification." - }, - "ProductId": { - "type": "integer", - "description": "Product ID." - }, - "FieldId": { - "type": "integer", - "description": "Specification ID." - }, - "FieldValueId": { - "type": "integer", - "description": "Current specification value ID." - }, - "Text": { - "type": "string", - "description": "Current specification value text." - } - } - } - } - } - } - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "The root schema comprises the entire JSON document.", - "example": { - "FieldName": "TesteAPI", - "GroupName": "TestGroup", - "RootLevelSpecification": true, - "FieldValues": [ - "Value123" - ] - }, - "required": [ - "FieldName", - "GroupName", - "RootLevelSpecification", - "FieldValues" - ], - "properties": { - "FieldName": { - "type": "string", - "description": "Specification name.", - "example": "TesteAPI" - }, - "GroupName": { - "type": "string", - "description": "Group name.", - "example": "TestGroup" - }, - "RootLevelSpecification": { - "type": "boolean", - "description": "Root level specification.", - "example": true - }, - "FieldValues": { - "type": "array", - "description": "Array of specification values.", - "example": [ - "Value123" - ], - "items": { - "type": "string", - "description": "Specification value.", - "example": "Value123" - } - } - } - } - } - } - } - } - }, - "/api/catalog_system/pvt/sku/stockkeepingunitids": { - "get": { - "tags": [ - "SKU" - ], - "summary": "List all SKU IDs", - "description": "Retrieves the IDs of all SKUs in the store. Presents the result with page size and pagination.", - "operationId": "ListallSKUsID", - "parameters": [ - { - "name": "page", - "in": "query", - "description": "Result page number that you need retrieves SKU ID", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "pagesize", - "in": "query", - "description": "Page size that you need retrieves SKU ID, maximum value 1000", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "integer", - "default": 25 - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "example": [ - 1, - 2, - 3, - 4, - 5, - 6, - 7, - 8, - 9, - 10 - ] - } - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pvt/sku/stockkeepingunitbyid/{skuId}": { - "get": { - "tags": [ - "SKU" - ], - "summary": "Get SKU and context", - "description": "Retrieves context of an SKU", - "operationId": "SkuContext", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "description": "SKU's unique identifier number", - "required": true, - "style": "simple", - "schema": { - "type": "integer", - "default": 2001773 - } - }, - { - "name": "sc", - "in": "query", - "description": "Trade Policy's unique identifier number", - "required": false, - "style": "form", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "", - "headers": { - "Cache-Control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Connection": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "keep-alive" - } - } - }, - "Content-Encoding": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "gzip" - } - } - }, - "Content-Length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "1044" - } - } - }, - "Date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Mon, 13 Feb 2017 15:15:02 GMT" - } - } - }, - "Expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-1" - } - } - }, - "Last-Modified": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Mon, 06 Feb 2017 14:32:02 GMT" - } - } - }, - "Pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "nginx" - } - } - }, - "Vary": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Accept-Encoding" - } - } - }, - "X-CacheServer": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "janus-apicache-nginx3" - } - } - }, - "X-Powered-by-VTEX-Janus-ApiCache": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "v1.3.9" - } - } - }, - "X-Powered-by-VTEX-Janus-Edge": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "v1.35.3" - } - } - }, - "X-Track": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "stable" - } - } - }, - "X-VTEX-Cache-Status-Janus-ApiCache": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "MISS" - } - } - }, - "X-VTEX-Cache-Status-Janus-Edge": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "MISS" - } - } - }, - "X-VTEX-Janus-Router-Backend-App": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "prtapi-v1.4.683-stable+527" - } - } - }, - "no": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-QTBJG9KGSVN" - } - } - }, - "p3p": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "policyref=\"/w3c/p3p.xml\",CP=\"ADMa OUR NOR CNT NID DSP NOI COR\"" - } - } - }, - "powered": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "vtex" - } - } - }, - "x-vtex-operation-id": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "b6c041c9-6da2-4012-a6c0-7af1ef1fe66e" - } - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Example4" - }, - "example": { - "Id": 2001773, - "ProductId": 2001426, - "NameComplete": "Tabela de Basquete", - "ProductName": "Tabela de Basquete", - "ProductDescription": "Tabela de Basquete", - "SkuName": "Tabela de Basquete", - "IsActive": true, - "IsTransported": true, - "IsInventoried": true, - "IsGiftCardRecharge": false, - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168952-55-55/7508800GG.jpg", - "DetailUrl": "/tabela-de-basquete/p", - "CSCIdentification": null, - "BrandId": "2000018", - "BrandName": "MARCA ARGOLO TESTE", - "Dimension": { - "cubicweight": 81.6833, - "height": 65, - "length": 58, - "weight": 10000, - "width": 130 - }, - "RealDimension": { - "realCubicWeight": 274.1375, - "realHeight": 241, - "realLength": 65, - "realWeight": 9800, - "realWidth": 105 - }, - "ManufacturerCode": "", - "IsKit": false, - "KitItems": [], - "Services": [], - "Categories": [], - "Attachments": [ - { - "Id": 3, - "Name": "Mensagem", - "Keys": [ - "nome;20", - "foto;40" - ], - "Fields": [ - { - "FieldName": "nome", - "MaxCaracters": "20", - "DomainValues": "Adalberto,Pedro,João" - }, - { - "FieldName": "foto", - "MaxCaracters": "40", - "DomainValues": null - } - ], - "IsActive": true, - "IsRequired": false - } - ], - "Collections": [], - "SkuSellers": [ - { - "SellerId": "1", - "StockKeepingUnitId": 2001773, - "SellerStockKeepingUnitId": "2001773", - "IsActive": true, - "FreightCommissionPercentage": 0, - "ProductCommissionPercentage": 0 - } - ], - "SalesChannels": [ - 1, - 2, - 3, - 10 - ], - "Images": [ - { - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168952/7508800GG.jpg", - "ImageName": "", - "FileId": 168952 - }, - { - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168953/7508800_1GG.jpg", - "ImageName": "", - "FileId": 168953 - }, - { - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168954/7508800_2GG.jpg", - "ImageName": "", - "FileId": 168954 - } - ], - "SkuSpecifications": [ - { - "FieldId": 102, - "FieldName": "Cor", - "FieldValueIds": [ - 266 - ], - "FieldValues": [ - "Padrão" - ] - } - ], - "ProductSpecifications": [ - { - "FieldId": 7, - "FieldName": "Faixa Etária", - "FieldValueIds": [ - 58, - 56, - 55, - 52 - ], - "FieldValues": [ - "5 a 6 anos", - "7 a 8 anos", - "9 a 10 anos", - "Acima de 10 anos" - ] - }, - { - "FieldId": 23, - "FieldName": "Fabricante", - "FieldValueIds": [], - "FieldValues": [ - "Xalingo" - ] - } - ], - "ProductClustersIds": "176,187,192,194,211,217,235,242", - "ProductCategoryIds": "/59/", - "ProductGlobalCategoryId": null, - "ProductCategories": { - "59": "Brinquedos" - }, - "CommercialConditionId": 1, - "RewardValue": 100.0, - "AlternateIds": { - "Ean": "8781", - "RefId": "878181" - }, - "AlternateIdValues": [ - "8781", - "878181" - ], - "EstimatedDateArrival": "", - "MeasurementUnit": "un", - "UnitMultiplier": 1, - "InformationSource": "Indexer", - "ModalType": "" - } - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog/pvt/stockkeepingunit": { - "get": { - "tags": [ - "SKU" - ], - "summary": "Get SKU by RefId", - "description": "Retrieves information about a specific SKU by its RefId", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "refId", - "in": "query", - "required": true, - "description": "SKU reference ID", - "schema": { - "type": "string", - "default": "1" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "Id": 1, - "ProductId": 1, - "IsActive": true, - "Name": "Royal Canin Feline Urinary 500g", - "RefId": "0001", - "PackagedHeight": 6.0, - "PackagedLength": 24.0, - "PackagedWidth": 14.0, - "PackagedWeightKg": 550.0, - "Height": 0.0, - "Length": 0.0, - "Width": 0.0, - "WeightKg": 0.0, - "CubicWeight": 1.0, - "IsKit": false, - "CreationDate": "2020-03-12T15:42:00", - "RewardValue": 0.0, - "EstimatedDateArrival": "", - "ManufacturerCode": "", - "CommercialConditionId": 1, - "MeasurementUnit": "un", - "UnitMultiplier": 1.0, - "ModalType": "", - "KitItensSellApart": false, - "Videos": null - }, - "schema": { - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "SKU ID." - }, - "ProductId": { - "type": "integer", - "description": "Product ID." - }, - "IsActive": { - "type": "boolean", - "description": "Shows if the SKU is active (`true`) or not (`false`)." - }, - "ActivateIfPossible": { - "type": "boolean", - "description": "When set to `true`, this attribute will automatically update the SKU as active once associated with an image or an active component." - }, - "Name": { - "type": "string", - "description": "SKU Name." - }, - "RefId": { - "type": "string", - "description": "SKU RefId." - }, - "PackagedHeight": { - "type": "number", - "description": "Packaged Height." - }, - "PackagedLength": { - "type": "number", - "description": "Packaged Length." - }, - "PackagedWidth": { - "type": "number", - "description": "Packaged Width." - }, - "PackagedWeightKg": { - "type": "number", - "description": "Packaged Weight in Kilos." - }, - "Height": { - "type": "number", - "description": "SKU Height." - }, - "Length": { - "type": "number", - "description": "SKU Length." - }, - "Width": { - "type": "number", - "description": "SKU Width." - }, - "WeightKg": { - "type": "number", - "description": "SKU Weight in Kilos." - }, - "CubicWeight": { - "type": "number", - "description": "[Cubic Weight](https://help.vtex.com/tutorial/understanding-the-cubic-weight-factor--tutorials_128)." - }, - "IsKit": { - "type": "boolean", - "description": "Shows if the SKU is a Kit (`true`) or not (`false`)." - }, - "CreationDate": { - "type": "string", - "description": "SKU Creation Date." - }, - "RewardValue": { - "type": "number", - "description": "How much the client will get rewarded by buying the SKU." - }, - "EstimatedDateArrival": { - "type": "string", - "description": "An explanation about the purpose of this instance." - }, - "ManufacturerCode": { - "type": "string", - "description": "SKU Estimated Date Arrival." - }, - "CommercialConditionId": { - "type": "integer", - "description": "Manufacturer Code." - }, - "MeasurementUnit": { - "type": "string", - "description": "Commercial Condition ID." - }, - "UnitMultiplier": { - "type": "number", - "description": "Measurement Unit." - }, - "ModalType": { - "type": "string", - "description": "Multiplies the amount of SKUs inserted on the cart." - }, - "KitItensSellApart": { - "type": "boolean", - "description": "Defines if Kit components can be sold apart." - }, - "Videos": { - "type": "string", - "description": "Videos URLs." - } - } - } - } - } - } - } - }, - "post": { - "tags": [ - "SKU" - ], - "summary": "Create SKU", - "description": "Creates a new SKU from scratch", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "Id": 70, - "ProductId": 42, - "IsActive": false, - "Name": "Size 10", - "RefId": "B096QW8Y8Z", - "PackagedHeight": 10.0, - "PackagedLength": 10.0, - "PackagedWidth": 10.0, - "PackagedWeightKg": 10.0, - "Height": 1.0, - "Length": 1.0, - "Width": 1.0, - "WeightKg": 1.0, - "CubicWeight": 0.1667, - "IsKit": false, - "CreationDate": "2020-01-25T15:51:29.2614605", - "RewardValue": 0.0, - "EstimatedDateArrival": "", - "ManufacturerCode": "", - "CommercialConditionId": 1, - "MeasurementUnit": "un", - "UnitMultiplier": 1.0, - "ModalType": "", - "KitItensSellApart": false, - "Videos": [] - }, - "schema": { - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "SKU unique identifier." - }, - "ProductId": { - "type": "integer", - "title": "ProductId", - "description": "Product's ID associated with this SKU." - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "Shows if the SKU is active (`true`) or not (`false`)." - }, - "Name": { - "type": "string", - "title": "Name", - "description": "SKU name, meaning the variation of the previously added product. For example: **Product** - _Fridge_, **SKU** - _110V_." - }, - "RefId": { - "type": "string", - "title": "RefId", - "description": "Reference code used internally for organizational purposes. Must be unique. It is not required only if EAN code already exists. If not, this field must be provided." - }, - "PackagedHeight": { - "type": "number", - "title": "PackagedHeight", - "description": "Height used for shipping calculation." - }, - "PackagedLength": { - "type": "number", - "title": "PackagedLength", - "description": "Length used for shipping calculation." - }, - "PackagedWidth": { - "type": "number", - "title": "PackagedWidth", - "description": "Width used for shipping calculation." - }, - "PackagedWeightKg": { - "type": "integer", - "title": "PackagedWeightKg", - "description": "Weight used for shipping calculation." - }, - "Height": { - "title": "Height", - "type": "number", - "description": "SKU real height." - }, - "Length": { - "title": "Length", - "type": "number", - "description": "SKU real length." - }, - "Width": { - "title": "Width", - "type": "number", - "description": "SKU real width." - }, - "WeightKg": { - "title": "WeightKg", - "type": "number", - "description": "SKU Weight." - }, - "CubicWeight": { - "title": "HeighCubicWeightt", - "type": "number", - "description": "[Cubic weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128)." - }, - "IsKit": { - "type": "boolean", - "title": "IsKit", - "description": "Flag to set whether the product SKU is made up of one or more SKUs, thereby becoming a bundle. Must be enabled if you are adding a bundle. Once activated, the flag cannot be reverted." - }, - "CreationDate": { - "type": "string", - "title": "The Creationdate Schema", - "description": "Date and time of the SKU's creation." - }, - "RewardValue": { - "title": "RewardValue", - "type": "number", - "description": "Credit that the customer receives when finalizing an order of one specific SKU unit. By filling this field out with `1`, the customer gets U$ 1 credit on the site." - }, - "EstimatedDateArrival": { - "title": "EstimatedDateArrival", - "type": "string", - "description": "To add the product as pre-sale, enter the product estimated arrival date. You must take into consideration both the launch date and the freight calculation for the arrival date." - }, - "ManufacturerCode": { - "type": "string", - "title": "ManufacturerCode", - "description": "Provided by the manufacturers to identify their product. This field should be completed if the product has a specific manufacturer’s code." - }, - "CommercialConditionId": { - "type": "integer", - "title": "CommercialConditionId", - "description": "Used to define SKU specific promotions or installment rules. Find out more by reading the Commercial Condition article. In case of no specific condition, use the default value." - }, - "MeasurementUnit": { - "type": "string", - "title": "MeasurementUnit", - "description": "Used only in cases when you need to convert the unit of measure for sale. If a product is sold in boxes for example, but customers want to buy per square meter (m²). In common cases, use `'un'`.", - "example": "un" - }, - "UnitMultiplier": { - "type": "integer", - "title": "UnitMultiplier", - "description": "This is the multiple number of SKU. If the Multiplier is 5, the product can be added in multiple quantities of 5, 10, 15, 20, onward." - }, - "ModalType": { - "title": "ModalType", - "type": "string", - "description": "Links an unusual type of product to a carrier specialized in delivering it. To learn more about this feature, read our articles [How the modal works](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125) and [Setting up modal for carriers](https://help.vtex.com/en/tutorial/configure-modal--3jhLqxuPhuiq24UoykCcqy)." - }, - "KitItensSellApart": { - "type": "boolean", - "title": "KitItensSellApart", - "description": "Defines if Kit components can be sold apart" - }, - "ActivateIfPossible": { - "type": "boolean", - "title": "ActivateIfPossible", - "description": "When set to `true`, this attribute will automatically update the SKU as active once associated with an image or an active component." - } - } - } - } - } - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "ProductId", - "Name", - "PackagedHeight", - "PackagedLength", - "PackagedWidth", - "PackagedWeightKg" - ], - "properties": { - "ProductId": { - "type": "integer", - "title": "ProductId", - "description": "Product's ID associated with this SKU.", - "example": 42 - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "Shows if the SKU is active (`true`) or not (`false`).", - "example": false - }, - "Name": { - "type": "string", - "title": "Name", - "description": "SKU name, meaning the variation of the previously added product. For example: **Product** - _Fridge_, **SKU** - _110V_.", - "example": "Size 10" - }, - "RefId": { - "type": "string", - "title": "RefId", - "description": "Reference code used internally for organizational purposes. Must be unique. It is not required only if EAN code already exists. If not, this field must be provided.", - "example": "B096QW8Y8Z" - }, - "PackagedHeight": { - "type": "number", - "title": "PackagedHeight", - "description": "Height used for shipping calculation.", - "example": 10 - }, - "PackagedLength": { - "type": "number", - "title": "PackagedLength", - "description": "Length used for shipping calculation.", - "example": 10 - }, - "PackagedWidth": { - "type": "number", - "title": "PackagedWidth", - "description": "Width used for shipping calculation.", - "example": 10 - }, - "PackagedWeightKg": { - "type": "integer", - "title": "PackagedWeightKg", - "description": "Weight used for shipping calculation.", - "example": 10 - }, - "Height": { - "title": "Height", - "type": "number", - "description": "SKU real height.", - "example": 1.0 - }, - "Length": { - "title": "Length", - "type": "number", - "description": "SKU real length.", - "example": 1.0 - }, - "Width": { - "title": "Width", - "type": "number", - "description": "SKU real width.", - "example": 1.0 - }, - "WeightKg": { - "title": "WeightKg", - "type": "number", - "description": "SKU Weight.", - "example": 1.0 - }, - "CubicWeight": { - "title": "HeighCubicWeightt", - "type": "number", - "description": "[Cubic weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128).", - "example": 0.1667 - }, - "IsKit": { - "type": "boolean", - "title": "IsKit", - "description": "Flag to set whether the product SKU is made up of one or more SKUs, thereby becoming a bundle. Must be enabled if you are adding a bundle. Once activated, the flag cannot be reverted.", - "example": false - }, - "CreationDate": { - "type": "string", - "title": "The Creationdate Schema", - "description": "Date and time of the SKU's creation.", - "example": "" - }, - "RewardValue": { - "title": "RewardValue", - "type": "number", - "description": "Credit that the customer receives when finalizing an order of one specific SKU unit. By filling this field out with `1`, the customer gets U$ 1 credit on the site.", - "example": 1.0 - }, - "EstimatedDateArrival": { - "title": "EstimatedDateArrival", - "type": "string", - "description": "To add the product as pre-sale, enter the product estimated arrival date. You must take into consideration both the launch date and the freight calculation for the arrival date.", - "example": "" - }, - "ManufacturerCode": { - "type": "string", - "title": "ManufacturerCode", - "description": "Provided by the manufacturers to identify their product. This field should be completed if the product has a specific manufacturer’s code.", - "example": "123" - }, - "CommercialConditionId": { - "type": "integer", - "title": "CommercialConditionId", - "description": "Used to define SKU specific promotions or installment rules. Find out more by reading the Commercial Condition article. In case of no specific condition, use the default value.", - "example": 1 - }, - "MeasurementUnit": { - "type": "string", - "title": "MeasurementUnit", - "description": "Used only in cases when you need to convert the unit of measure for sale. If a product is sold in boxes for example, but customers want to buy per square meter (m²). In common cases, use `'un'`.", - "example": "un" - }, - "UnitMultiplier": { - "type": "integer", - "title": "UnitMultiplier", - "description": "This is the multiple number of SKU. If the Multiplier is 5, the product can be added in multiple quantities of 5, 10, 15, 20, onward.", - "example": 1 - }, - "ModalType": { - "title": "ModalType", - "type": "string", - "description": "Links an unusual type of product to a carrier specialized in delivering it. To learn more about this feature, read our articles [How the modal works](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125) and [Setting up modal for carriers](https://help.vtex.com/en/tutorial/configure-modal--3jhLqxuPhuiq24UoykCcqy).", - "example": "" - }, - "KitItensSellApart": { - "type": "boolean", - "title": "KitItensSellApart", - "description": "Defines if Kit components can be sold apart", - "example": false - }, - "ActivateIfPossible": { - "type": "boolean", - "title": "ActivateIfPossible", - "description": "When set to `true`, this attribute will automatically update the SKU as active once associated with an image or an active component.", - "example": true - } - } - } - } - } - } - } - }, - "/api/catalog_system/pvt/sku/stockkeepingunitidbyrefid/{refId}": { - "get": { - "tags": [ - "SKU" - ], - "summary": "Get SkuId by RefId", - "description": "Retrieves an SKU ID by the SKU's Reference ID.", - "operationId": "SkuIdbyRefId", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "refId", - "in": "path", - "description": "SKU reference ID", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "0001" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "description": "SKU ID.", - "example": "1" - } - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pvt/sku/stockkeepingunitbyalternateId/{alternateId}": { - "get": { - "tags": [ - "SKU" - ], - "summary": "Get SKU by Alternate ID", - "description": "Retrieves an SKU by its Alternate ID.", - "operationId": "SkubyAlternateId", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "alternateId", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": { - "Cache-Control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Connection": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "keep-alive" - } - } - }, - "Content-Encoding": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "gzip" - } - } - }, - "Date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Thu, 16 Feb 2017 15:21:38 GMT" - } - } - }, - "Expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-1" - } - } - }, - "Pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "nginx" - } - } - }, - "Transfer-Encoding": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "chunked" - } - } - }, - "Vary": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Accept-Encoding, Accept-Encoding" - } - } - }, - "X-CacheServer": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "janus-apicache-nginx14" - } - } - }, - "X-Powered-by-VTEX-Janus-ApiCache": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "v1.3.9" - } - } - }, - "X-Powered-by-VTEX-Janus-Edge": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "v1.36.0-beta" - } - } - }, - "X-Track": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "beta" - } - } - }, - "X-Translate": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "1" - } - } - }, - "X-Translate-BackEnd": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "http%3A%2F%2Fbeta.janus-router-v2.vtexinternal.com.br%2Fapi%2Fcatalog_system%2Fpvt%2Fsku%2FstockkeepingunitbyalternateId%2F8781" - } - } - }, - "X-VTEX-Cache-Status-Janus-ApiCache": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "MISS" - } - } - }, - "X-VTEX-Cache-Status-Janus-Edge": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "MISS" - } - } - }, - "X-VTEX-Janus-Router-Backend-App": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "prtapi-v1.4.691-beta.1+530" - } - } - }, - "no": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-8NLU58HJKL2" - } - } - }, - "p3p": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "policyref=\"/w3c/p3p.xml\",CP=\"ADMa OUR NOR CNT NID DSP NOI COR\"" - } - } - }, - "powered": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "vtex" - } - } - }, - "x-vtex-operation-id": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "3afef265-3349-4726-842c-638308243e05" - } - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Example5" - }, - "example": { - "Id": 2001773, - "ProductId": 2001426, - "NameComplete": "Tabela de Basquete", - "ProductName": "Tabela de Basquete", - "ProductDescription": "Tabela de Basquete", - "SkuName": "Tabela de Basquete", - "IsActive": true, - "IsTransported": true, - "IsInventoried": true, - "IsGiftCardRecharge": false, - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168952-55-55/7508800GG.jpg", - "DetailUrl": "/tabela-de-basquete/p", - "CSCIdentification": null, - "BrandId": "2000018", - "BrandName": "MARCA ARGOLO TESTE", - "Dimension": { - "cubicweight": 81.6833, - "height": 65, - "length": 58, - "weight": 10000, - "width": 130 - }, - "RealDimension": { - "realCubicWeight": 274.1375, - "realHeight": 241, - "realLength": 65, - "realWeight": 9800, - "realWidth": 105 - }, - "ManufacturerCode": "", - "IsKit": false, - "KitItems": [], - "Services": [], - "Categories": [], - "Attachments": [ - { - "Id": 3, - "Name": "Mensagem", - "Keys": [ - "nome;20", - "foto;40" - ], - "Fields": [ - { - "FieldName": "nome", - "MaxCaracters": "20", - "DomainValues": "Adalberto,Pedro,João" - }, - { - "FieldName": "foto", - "MaxCaracters": "40", - "DomainValues": null - } - ], - "IsActive": true, - "IsRequired": false - } - ], - "Collections": [], - "SkuSellers": [ - { - "SellerId": "1", - "StockKeepingUnitId": 2001773, - "SellerStockKeepingUnitId": "2001773", - "IsActive": true, - "FreightCommissionPercentage": 0, - "ProductCommissionPercentage": 0 - } - ], - "SalesChannels": [ - 1, - 2, - 3, - 10 - ], - "Images": [ - { - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168952/7508800GG.jpg", - "ImageName": "", - "FileId": 168952 - }, - { - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168953/7508800_1GG.jpg", - "ImageName": "", - "FileId": 168953 - }, - { - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168954/7508800_2GG.jpg", - "ImageName": "", - "FileId": 168954 - } - ], - "SkuSpecifications": [ - { - "FieldId": 102, - "FieldName": "Cor", - "FieldValueIds": [ - 266 - ], - "FieldValues": [ - "Padrão" - ] - } - ], - "ProductSpecifications": [ - { - "FieldId": 7, - "FieldName": "Faixa Etária", - "FieldValueIds": [ - 58, - 56, - 55, - 52 - ], - "FieldValues": [ - "5 a 6 anos", - "7 a 8 anos", - "9 a 10 anos", - "Acima de 10 anos" - ] - }, - { - "FieldId": 23, - "FieldName": "Fabricante", - "FieldValueIds": [], - "FieldValues": [ - "Xalingo" - ] - } - ], - "ProductClustersIds": "176,187,192,194,211,217,235,242", - "ProductCategoryIds": "/59/", - "ProductGlobalCategoryId": null, - "ProductCategories": { - "59": "Brinquedos" - }, - "CommercialConditionId": 1, - "RewardValue": 100.0, - "AlternateIds": { - "Ean": "8781", - "RefId": "878181" - }, - "AlternateIdValues": [ - "8781", - "878181" - ], - "EstimatedDateArrival": "", - "MeasurementUnit": "un", - "UnitMultiplier": 1, - "InformationSource": null, - "ModalType": "" - } - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pvt/sku/stockkeepingunitByProductId/{productId}": { - "get": { - "tags": [ - "SKU" - ], - "summary": "Get SKU list by ProductId", - "description": "Retrieves a list with the SKUs related to a product by the product's ID.", - "operationId": "SkulistbyProductId", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "description": "Product’s unique numerical identifier", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": { - "Cache-Control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Connection": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "keep-alive" - } - } - }, - "Content-Encoding": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "gzip" - } - } - }, - "Content-Length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "535" - } - } - }, - "Date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Mon, 07 Aug 2017 22:10:41 GMT" - } - } - }, - "Expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-1" - } - } - }, - "Pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "nginx" - } - } - }, - "Vary": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Accept-Encoding" - } - } - }, - "X-CacheServer": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "janus-apicache-nginx15" - } - } - }, - "X-Powered-by-VTEX-Janus-ApiCache": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "v1.3.9" - } - } - }, - "X-Powered-by-VTEX-Janus-Edge": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "v1.38.0" - } - } - }, - "X-Track": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "stable" - } - } - }, - "X-VTEX-Cache-Status-Janus-ApiCache": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "MISS" - } - } - }, - "X-VTEX-Cache-Status-Janus-Edge": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "MISS" - } - } - }, - "X-VTEX-Janus-Router-Backend-App": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "prtapi-v1.4.779-stable+579" - } - } - }, - "no": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-LKUTNPH8G7F" - } - } - }, - "p3p": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "policyref=\"/w3c/p3p.xml\",CP=\"ADMa OUR NOR CNT NID DSP NOI COR\"" - } - } - }, - "powered": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "vtex" - } - } - }, - "x-vtex-operation-id": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "316e0c8f-7aa1-41dc-859e-47ba1fcb4b0f" - } - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/example7" - }, - "example": [ - { - "IsPersisted": true, - "IsRemoved": false, - "Id": 2000035, - "ProductId": 2000024, - "IsActive": true, - "Name": "33 - Preto", - "Height": 8, - "RealHeight": null, - "Width": 15, - "RealWidth": null, - "Length": 8, - "RealLength": null, - "WeightKg": 340, - "RealWeightKg": null, - "ModalId": 1, - "RefId": "", - "CubicWeight": 0.2, - "IsKit": false, - "IsDynamicKit": null, - "InternalNote": null, - "DateUpdated": "2015-11-06T19:10:00", - "RewardValue": 0.01, - "CommercialConditionId": 1, - "EstimatedDateArrival": "", - "FlagKitItensSellApart": false, - "ManufacturerCode": "", - "ReferenceStockKeepingUnitId": null, - "Position": 0, - "EditionSkuId": null, - "ApprovedAdminId": 123, - "EditionAdminId": 123, - "ActivateIfPossible": true, - "SupplierCode": null, - "MeasurementUnit": "un", - "UnitMultiplier": 1, - "IsInventoried": null, - "IsTransported": null, - "IsGiftCardRecharge": null, - "ModalType": "" - }, - { - "IsPersisted": true, - "IsRemoved": false, - "Id": 2000036, - "ProductId": 2000024, - "IsActive": true, - "Name": "33 - Amarelo", - "Height": 8, - "RealHeight": null, - "Width": 15, - "RealWidth": null, - "Length": 8, - "RealLength": null, - "WeightKg": 340, - "RealWeightKg": null, - "ModalId": 1, - "RefId": "", - "CubicWeight": 0.2, - "IsKit": false, - "IsDynamicKit": null, - "InternalNote": null, - "DateUpdated": "2015-11-06T19:10:00", - "RewardValue": 0.0, - "CommercialConditionId": 1, - "EstimatedDateArrival": "", - "FlagKitItensSellApart": false, - "ManufacturerCode": "", - "ReferenceStockKeepingUnitId": null, - "Position": 0, - "EditionSkuId": null, - "ApprovedAdminId": 93, - "EditionAdminId": 93, - "ActivateIfPossible": true, - "SupplierCode": null, - "MeasurementUnit": "un", - "UnitMultiplier": 1, - "IsInventoried": null, - "IsTransported": null, - "IsGiftCardRecharge": null, - "ModalType": "" - }, - { - "IsPersisted": true, - "IsRemoved": false, - "Id": 2389673, - "ProductId": 2000024, - "IsActive": true, - "Name": "33 - Amarelo Copy", - "Height": 8, - "RealHeight": null, - "Width": 15, - "RealWidth": null, - "Length": 8, - "RealLength": null, - "WeightKg": 340, - "RealWeightKg": null, - "ModalId": 1, - "RefId": "", - "CubicWeight": 0.2, - "IsKit": false, - "IsDynamicKit": null, - "InternalNote": null, - "DateUpdated": "2012-09-26T21:37:00", - "RewardValue": 0.0, - "CommercialConditionId": 1, - "EstimatedDateArrival": "", - "FlagKitItensSellApart": false, - "ManufacturerCode": "", - "ReferenceStockKeepingUnitId": null, - "Position": 0, - "EditionSkuId": null, - "ApprovedAdminId": 123, - "EditionAdminId": 123, - "ActivateIfPossible": true, - "SupplierCode": null, - "MeasurementUnit": "un", - "UnitMultiplier": 1, - "IsInventoried": null, - "IsTransported": null, - "IsGiftCardRecharge": null, - "ModalType": "" - }, - { - "IsPersisted": true, - "IsRemoved": false, - "Id": 2389674, - "ProductId": 2000024, - "IsActive": true, - "Name": "33 - Amarelo Copy", - "Height": 8, - "RealHeight": null, - "Width": 15, - "RealWidth": null, - "Length": 8, - "RealLength": null, - "WeightKg": 340, - "RealWeightKg": null, - "ModalId": 1, - "RefId": "", - "CubicWeight": 0.2, - "IsKit": false, - "IsDynamicKit": null, - "InternalNote": null, - "DateUpdated": "2012-09-26T21:37:00", - "RewardValue": 0.0, - "CommercialConditionId": 1, - "EstimatedDateArrival": "", - "FlagKitItensSellApart": false, - "ManufacturerCode": "", - "ReferenceStockKeepingUnitId": null, - "Position": 0, - "EditionSkuId": null, - "ApprovedAdminId": 123, - "EditionAdminId": 123, - "ActivateIfPossible": true, - "SupplierCode": null, - "MeasurementUnit": "un", - "UnitMultiplier": 1, - "IsInventoried": null, - "IsTransported": null, - "IsGiftCardRecharge": null, - "ModalType": "" - } - ] - } - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pub/sku/stockkeepingunitidsbyrefids": { - "post": { - "tags": [ - "SKU" - ], - "summary": "Retrieve SkuId list by RefId list", - "description": "Receives a list of Reference IDs and returns the same list with the corresponding SKU IDs. ", - "operationId": "SkuIdlistbyRefIdlist", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "array", - "title": "body", - "description": "Array with SKU reference ID that you need identify the SKU IDs", - "required": [ - "RefId" - ], - "items": { - "type": "integer", - "title": "RefId", - "description": "Reference ID", - "default": 799 - } - } - } - } - }, - "responses": { - "200": { - "description": "", - "headers": { - "Cache-Control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Connection": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "keep-alive" - } - } - }, - "Content-Encoding": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "gzip" - } - } - }, - "Content-Length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "189" - } - } - }, - "Date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Thu, 31 May 2018 14:45:26 GMT" - } - } - }, - "Expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-1" - } - } - }, - "Pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Microsoft-IIS/8.5" - } - } - }, - "Vary": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Accept-Encoding" - } - } - }, - "X-AspNet-Version": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "4.0.30319" - } - } - }, - "X-Powered-By": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "ASP.NET" - } - } - }, - "X-VTEX-Janus-Router-Backend-App": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "prtapi-v1.4.974-stable+738" - } - } - }, - "no": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-86FN1DUJ89D" - } - } - }, - "p3p": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "policyref=\"/w3c/p3p.xml\",CP=\"ADMa OUR NOR CNT NID DSP NOI COR\"" - } - } - }, - "powered": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "vtex" - } - } - }, - "x-vtex-operation-id": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "0e0702f1-95e7-4e2b-97cf-0a370aa78abb" - } - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Example8", - "example": { - "123": null, - "D25133K-B2": "4351", - "14-556": "3155", - "DCF880L2-BR": "4500" - } - } - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog/pvt/stockkeepingunit/{skuId}": { - "get": { - "tags": [ - "SKU" - ], - "summary": "Get SKU", - "description": "Retrieves a specific SKU by its ID. This information is exactly what is needed to create a new SKU.", - "operationId": "Sku", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "description": "SKU unique identifier number.", - "required": true, - "style": "simple", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "", - "headers": { - "Cache-Control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Connection": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "keep-alive" - } - } - }, - "Content-Encoding": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "gzip" - } - } - }, - "Content-Length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "1044" - } - } - }, - "Date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Mon, 13 Feb 2017 15:15:02 GMT" - } - } - }, - "Expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-1" - } - } - }, - "Last-Modified": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Mon, 06 Feb 2017 14:32:02 GMT" - } - } - }, - "Pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "nginx" - } - } - }, - "Vary": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Accept-Encoding" - } - } - }, - "X-CacheServer": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "janus-apicache-nginx3" - } - } - }, - "X-Powered-by-VTEX-Janus-ApiCache": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "v1.3.9" - } - } - }, - "X-Powered-by-VTEX-Janus-Edge": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "v1.35.3" - } - } - }, - "X-Track": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "stable" - } - } - }, - "X-VTEX-Cache-Status-Janus-ApiCache": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "MISS" - } - } - }, - "X-VTEX-Cache-Status-Janus-Edge": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "MISS" - } - } - }, - "X-VTEX-Janus-Router-Backend-App": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "prtapi-v1.4.683-stable+527" - } - } - }, - "no": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-QTBJG9KGSVN" - } - } - }, - "p3p": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "policyref=\"/w3c/p3p.xml\",CP=\"ADMa OUR NOR CNT NID DSP NOI COR\"" - } - } - }, - "powered": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "vtex" - } - } - }, - "x-vtex-operation-id": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "b6c041c9-6da2-4012-a6c0-7af1ef1fe66e" - } - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Example4" - } - } - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "SKU" - ], - "summary": "Update SKU", - "description": "Updates an existing SKU", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": "SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "Id": 70, - "ProductId": 42, - "IsActive": false, - "Name": "Size 10", - "RefId": "B096QW8Y8Z", - "PackagedHeight": 10.0, - "PackagedLength": 10.0, - "PackagedWidth": 10.0, - "PackagedWeightKg": 10.0, - "Height": 1.0, - "Length": 1.0, - "Width": 1.0, - "WeightKg": 1.0, - "CubicWeight": 0.1667, - "IsKit": false, - "CreationDate": "2020-01-25T15:51:29.2614605", - "RewardValue": 0.0, - "EstimatedDateArrival": "", - "ManufacturerCode": "", - "CommercialConditionId": 1, - "MeasurementUnit": "un", - "UnitMultiplier": 1.0, - "ModalType": "", - "KitItensSellApart": false, - "Videos": [] - }, - "schema": { - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "SKU unique identifier." - }, - "ProductId": { - "type": "integer", - "title": "ProductId", - "description": "Product's ID associated with this SKU." - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "Shows if the SKU is active (`true`) or not (`false`)." - }, - "Name": { - "type": "string", - "title": "Name", - "description": "SKU name, meaning the variation of the previously added product. For example: **Product** - _Fridge_, **SKU** - _110V_." - }, - "RefId": { - "type": "string", - "title": "RefId", - "description": "Reference code used internally for organizational purposes. Must be unique. It is not required only if EAN code already exists. If not, this field must be provided." - }, - "PackagedHeight": { - "type": "number", - "title": "PackagedHeight", - "description": "Height used for shipping calculation." - }, - "PackagedLength": { - "type": "number", - "title": "PackagedLength", - "description": "Length used for shipping calculation." - }, - "PackagedWidth": { - "type": "number", - "title": "PackagedWidth", - "description": "Width used for shipping calculation." - }, - "PackagedWeightKg": { - "type": "integer", - "title": "PackagedWeightKg", - "description": "Weight used for shipping calculation." - }, - "Height": { - "title": "Height", - "type": "number", - "description": "SKU real height." - }, - "Length": { - "title": "Length", - "type": "number", - "description": "SKU real length." - }, - "Width": { - "title": "Width", - "type": "number", - "description": "SKU real width." - }, - "WeightKg": { - "title": "WeightKg", - "type": "number", - "description": "SKU Weight." - }, - "CubicWeight": { - "title": "HeighCubicWeightt", - "type": "number", - "description": "[Cubic weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128)." - }, - "IsKit": { - "type": "boolean", - "title": "IsKit", - "description": "Flag to set whether the product SKU is made up of one or more SKUs, thereby becoming a bundle. Must be enabled if you are adding a bundle. Once activated, the flag cannot be reverted." - }, - "CreationDate": { - "type": "string", - "description": "Date and time of the SKU's creation." - }, - "RewardValue": { - "title": "RewardValue", - "type": "number", - "description": "Credit that the customer receives when finalizing an order of one specific SKU unit. By filling this field out with `1`, the customer gets U$ 1 credit on the site." - }, - "EstimatedDateArrival": { - "title": "EstimatedDateArrival", - "type": "string", - "description": "To add the product as pre-sale, enter the product estimated arrival date. You must take into consideration both the launch date and the freight calculation for the arrival date." - }, - "ManufacturerCode": { - "type": "string", - "title": "ManufacturerCode", - "description": "Provided by the manufacturers to identify their product. This field should be completed if the product has a specific manufacturer’s code." - }, - "CommercialConditionId": { - "type": "integer", - "title": "CommercialConditionId", - "description": "Used to define SKU specific promotions or installment rules. Find out more by reading the Commercial Condition article. In case of no specific condition, use the default value." - }, - "MeasurementUnit": { - "type": "string", - "title": "MeasurementUnit", - "description": "Used only in cases when you need to convert the unit of measure for sale. If a product is sold in boxes for example, but customers want to buy per square meter (m²). In common cases, use `'un'`.", - "example": "un" - }, - "UnitMultiplier": { - "type": "integer", - "title": "UnitMultiplier", - "description": "This is the multiple number of SKU. If the Multiplier is 5, the product can be added in multiple quantities of 5, 10, 15, 20, onward." - }, - "ModalType": { - "title": "ModalType", - "type": "string", - "description": "Links an unusual type of product to a carrier specialized in delivering it. To learn more about this feature, read our articles [How the modal works](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125) and [Setting up modal for carriers](https://help.vtex.com/en/tutorial/configure-modal--3jhLqxuPhuiq24UoykCcqy)." - }, - "KitItensSellApart": { - "type": "boolean", - "title": "KitItensSellApart", - "description": "Defines if Kit components can be sold apart" - }, - "ActivateIfPossible": { - "type": "boolean", - "title": "ActivateIfPossible", - "description": "When set to `true`, this attribute will automatically update the SKU as active once associated with an image or an active component." - } - } - } - } - } - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "ProductId", - "Name", - "PackagedHeight", - "PackagedLength", - "PackagedWidth", - "PackagedWeightKg" - ], - "properties": { - "ProductId": { - "type": "integer", - "title": "ProductId", - "description": "Product's ID associated with this SKU.", - "example": 42 - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "Shows if the SKU is active (`true`) or not (`false`).", - "example": false - }, - "Name": { - "type": "string", - "title": "Name", - "description": "SKU name, meaning the variation of the previously added product. For example: **Product** - _Fridge_, **SKU** - _110V_.", - "example": "Size 10" - }, - "RefId": { - "type": "string", - "title": "RefId", - "description": "Reference code used internally for organizational purposes. Must be unique. It is not required only if EAN code already exists. If not, this field must be provided.", - "example": "B096QW8Y8Z" - }, - "PackagedHeight": { - "type": "number", - "title": "PackagedHeight", - "description": "Height used for shipping calculation.", - "example": 10 - }, - "PackagedLength": { - "type": "number", - "title": "PackagedLength", - "description": "Length used for shipping calculation.", - "example": 10 - }, - "PackagedWidth": { - "type": "number", - "title": "PackagedWidth", - "description": "Width used for shipping calculation.", - "example": 10 - }, - "PackagedWeightKg": { - "type": "integer", - "title": "PackagedWeightKg", - "description": "Weight used for shipping calculation.", - "example": 10 - }, - "Height": { - "title": "Height", - "type": "number", - "description": "SKU real height.", - "example": 1.0 - }, - "Length": { - "title": "Length", - "type": "number", - "description": "SKU real length.", - "example": 1.0 - }, - "Width": { - "title": "Width", - "type": "number", - "description": "SKU real width.", - "example": 1.0 - }, - "WeightKg": { - "title": "WeightKg", - "type": "number", - "description": "SKU Weight.", - "example": 1.0 - }, - "CubicWeight": { - "title": "HeighCubicWeightt", - "type": "number", - "description": "[Cubic weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128).", - "example": 0.1667 - }, - "IsKit": { - "type": "boolean", - "title": "IsKit", - "description": "Flag to set whether the product SKU is made up of one or more SKUs, thereby becoming a bundle. Must be enabled if you are adding a bundle. Once activated, the flag cannot be reverted.", - "example": false - }, - "CreationDate": { - "type": "string", - "title": "The Creationdate Schema", - "description": "Date and time of the SKU's creation.", - "example": "2020-01-25T15:51:00" - }, - "RewardValue": { - "title": "RewardValue", - "type": "number", - "description": "Credit that the customer receives when finalizing an order of one specific SKU unit. By filling this field out with `1`, the customer gets U$ 1 credit on the site.", - "example": 1.0 - }, - "EstimatedDateArrival": { - "title": "EstimatedDateArrival", - "type": "string", - "description": "To add the product as pre-sale, enter the product estimated arrival date. You must take into consideration both the launch date and the freight calculation for the arrival date.", - "example": "" - }, - "ManufacturerCode": { - "type": "string", - "title": "ManufacturerCode", - "description": "Provided by the manufacturers to identify their product. This field should be completed if the product has a specific manufacturer’s code.", - "example": "123" - }, - "CommercialConditionId": { - "type": "integer", - "title": "CommercialConditionId", - "description": "Used to define SKU specific promotions or installment rules. Find out more by reading the Commercial Condition article. In case of no specific condition, use the default value.", - "example": 1 - }, - "MeasurementUnit": { - "type": "string", - "title": "MeasurementUnit", - "description": "Used only in cases when you need to convert the unit of measure for sale. If a product is sold in boxes for example, but customers want to buy per square meter (m²). In common cases, use `'un'`.", - "example": "un" - }, - "UnitMultiplier": { - "type": "integer", - "title": "UnitMultiplier", - "description": "This is the multiple number of SKU. If the Multiplier is 5, the product can be added in multiple quantities of 5, 10, 15, 20, onward.", - "example": 1 - }, - "ModalType": { - "title": "ModalType", - "type": "string", - "description": "Links an unusual type of product to a carrier specialized in delivering it. To learn more about this feature, read our articles [How the modal works](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125) and [Setting up modal for carriers](https://help.vtex.com/en/tutorial/configure-modal--3jhLqxuPhuiq24UoykCcqy).", - "example": "" - }, - "KitItensSellApart": { - "type": "boolean", - "title": "KitItensSellApart", - "description": "Defines if Kit components can be sold apart", - "example": false - }, - "ActivateIfPossible": { - "type": "boolean", - "title": "ActivateIfPossible", - "description": "When set to `true`, this attribute will automatically update the SKU as active once associated with an image or an active component.", - "example": true - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/stockkeepingunit/{skuId}/complement": { - "get": { - "tags": [ - "SKU Complement" - ], - "summary": "Get SKU Complement by SKU ID", - "description": "Retrieves a existing Complement of an SKU by its SKU ID", - "operationId": "GetSKUComplementbySKUID", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": " SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/stockkeepingunit/{skuId}/complement/{complementTypeId}": { - "get": { - "tags": [ - "SKU Complement" - ], - "summary": "Get SKU Complements by Complement Type ID", - "description": "Retrieves all the existing SKU Complements with the same Complement Type ID of a specific SKU", - "operationId": "GetSKUComplementsbyComplementTypeID", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": " SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "complementTypeId", - "in": "path", - "required": true, - "description": " Type of the complement you are inserting on the SKU. The possible values are: `1` to *assessor*; `2` to *suggestion*; `3` to *similar*; 5 to *show together*.", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog_system/pvt/sku/complements/{skuId}/{type}": { - "get": { - "tags": [ - "SKU Complement" - ], - "summary": "Get SKU complements by type", - "description": "Retrieves all the existing SKU complements with the same complement type ID of a specific SKU", - "operationId": "GetSKUcomplementsbytype", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": " SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "type", - "in": "path", - "required": true, - "description": " Type of the complement you are inserting on the SKU. The possible values are: `1` to *assessor*; `2` to *suggestion*; `3` to *similar*; 5 to *show together*.", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "example": { - "ParentSkuId": 1, - "ComplementSkuIds": [ - 7 - ], - "Type": "1" - }, - "type": "object", - "title": "", - "required": [ - "ParentSkuId", - "ComplementSkuIds", - "Type" - ], - "properties": { - "ParentSkuId": { - "type": "integer", - "title": "ParentSkuId", - "description": "SKU in which you are inserting the complement", - "default": 1 - }, - "ComplementSkuIds": { - "type": "array", - "title": "ComplementSkuIds", - "description": "Array with SKU complements IDs", - "default": [ - 7 - ], - "items": { - "type": "integer", - "title": "", - "description": "SKU Complement ID", - "default": 7 - } - }, - "Type": { - "type": "string", - "title": "Type", - "description": "Type of the complement you are inserting on the SKU. The possible values are: `1` to *assessor*; `2` to *suggestion*; `3` to *similar*; 5 to *show together*.", - "default": "1" - } - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/skucomplement": { - "post": { - "tags": [ - "SKU Complement" - ], - "summary": "Create SKU Complement", - "description": "Creates a new SKU Complement on a Parent SKU", - "operationId": "CreateSKUComplement", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "example": { - "ParentSkuId": 1, - "SkuId": 1, - "ComplementTypeId": 1 - }, - "type": "object", - "title": "Request body", - "required": [ - "ParentSkuId", - "SkuId", - "ComplementTypeId" - ], - "properties": { - "ParentSkuId": { - "type": "integer", - "title": "ParentSkuId", - "description": "SKU in which you are inserting the Complement", - "default": 1 - }, - "SkuId": { - "type": "integer", - "title": "SkuId", - "description": "SKU in which you are inserting as a Complement in the Parent SKU", - "default": 1 - }, - "ComplementTypeId": { - "type": "integer", - "title": "ComplementTypeId", - "description": "Type of the complement you are inserting on the SKU. The possible values are: `1` to *assessor*; `2` to *suggestion*; `3` to *similar*; 5 to *show together*.", - "default": 1 - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/skucomplement/{skuComplementId}": { - "get": { - "tags": [ - "SKU Complement" - ], - "summary": "Get SKU Complement by SKU Complement ID", - "description": "Retrieves a existing Complement of an SKU by its SKU Complement ID", - "operationId": "GetSKUComplementbySKUComplementID", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuComplementId", - "in": "path", - "required": true, - "description": " SKU Complement’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - }, - "delete": { - "tags": [ - "SKU Complement" - ], - "summary": "Delete SKU Complement by SKU Complement ID", - "description": "Deletes a previously existing Complement of an SKU by SKU Complement ID", - "operationId": "DeleteSKUComplementbySKUComplementID", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuComplementId", - "in": "path", - "required": true, - "description": " SKU Complement’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "required": [ - "ParentSkuId", - "SkuId", - "ComplementTypeId" - ], - "properties": { - "ParentSkuId": { - "type": "integer", - "title": "ParentSkuId", - "description": "SKU in which you are inserting the Complement", - "default": 1 - }, - "SkuId": { - "type": "integer", - "title": "SkuId", - "description": "SKU in which you are inserting as a Complement in the Parent SKU", - "default": 1 - }, - "ComplementTypeId": { - "type": "integer", - "title": "ComplementTypeId", - "description": "Type of the complement you are inserting on the SKU. The possible values are: `1` to *assessor*; `2` to *suggestion*; `3` to *similar*; 5 to *show together*.", - "default": 1 - } - } - } - } - } - } - } - }, - "/api/catalog_system/pvt/sku/stockkeepingunitbyean/{ean}": { - "get": { - "tags": [ - "SKU EAN" - ], - "summary": "Get SKU by EAN", - "description": "Retrieves an SKU by its EAN ID.", - "operationId": "SkubyEAN", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "ean", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": { - "Cache-Control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Connection": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "keep-alive" - } - } - }, - "Content-Encoding": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "gzip" - } - } - }, - "Content-Length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "1035" - } - } - }, - "Date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Thu, 16 Feb 2017 15:19:46 GMT" - } - } - }, - "Expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-1" - } - } - }, - "Pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "nginx" - } - } - }, - "Vary": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Accept-Encoding" - } - } - }, - "X-CacheServer": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "janus-apicache-nginx10" - } - } - }, - "X-Powered-by-VTEX-Janus-ApiCache": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "v1.3.9" - } - } - }, - "X-Powered-by-VTEX-Janus-Edge": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "v1.35.3" - } - } - }, - "X-Track": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "stable" - } - } - }, - "X-VTEX-Cache-Status-Janus-ApiCache": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "MISS" - } - } - }, - "X-VTEX-Cache-Status-Janus-Edge": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "MISS" - } - } - }, - "X-VTEX-Janus-Router-Backend-App": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "prtapi-v1.4.683-stable+527" - } - } - }, - "no": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-QTBJG9KGSVN" - } - } - }, - "p3p": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "policyref=\"/w3c/p3p.xml\",CP=\"ADMa OUR NOR CNT NID DSP NOI COR\"" - } - } - }, - "powered": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "vtex" - } - } - }, - "x-vtex-operation-id": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "4d81466f-3a82-4fd0-93f7-d11f64545365" - } - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Example5" - }, - "example": { - "Id": 2001773, - "ProductId": 2001426, - "NameComplete": "Tabela de Basquete", - "ProductName": "Tabela de Basquete", - "ProductDescription": "Tabela de Basquete", - "SkuName": "Tabela de Basquete", - "IsActive": true, - "IsTransported": true, - "IsInventoried": true, - "IsGiftCardRecharge": false, - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168952-55-55/7508800GG.jpg", - "DetailUrl": "/tabela-de-basquete/p", - "CSCIdentification": null, - "BrandId": "2000018", - "BrandName": "MARCA ARGOLO TESTE", - "Dimension": { - "cubicweight": 81.6833, - "height": 65, - "length": 58, - "weight": 10000, - "width": 130 - }, - "RealDimension": { - "realCubicWeight": 274.1375, - "realHeight": 241, - "realLength": 65, - "realWeight": 9800, - "realWidth": 105 - }, - "ManufacturerCode": "", - "IsKit": false, - "KitItems": [], - "Services": [], - "Categories": [], - "Attachments": [ - { - "Id": 3, - "Name": "Mensagem", - "Keys": [ - "nome;20", - "foto;40" - ], - "Fields": [ - { - "FieldName": "nome", - "MaxCaracters": "20", - "DomainValues": "Adalberto,Pedro,João" - }, - { - "FieldName": "foto", - "MaxCaracters": "40", - "DomainValues": null - } - ], - "IsActive": true, - "IsRequired": false - } - ], - "Collections": [], - "SkuSellers": [ - { - "SellerId": "1", - "StockKeepingUnitId": 2001773, - "SellerStockKeepingUnitId": "2001773", - "IsActive": true, - "FreightCommissionPercentage": 0, - "ProductCommissionPercentage": 0 - } - ], - "SalesChannels": [ - 1, - 2, - 3, - 10 - ], - "Images": [ - { - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168952/7508800GG.jpg", - "ImageName": "", - "FileId": 168952 - }, - { - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168953/7508800_1GG.jpg", - "ImageName": "", - "FileId": 168953 - }, - { - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168954/7508800_2GG.jpg", - "ImageName": "", - "FileId": 168954 - } - ], - "SkuSpecifications": [ - { - "FieldId": 102, - "FieldName": "Cor", - "FieldValueIds": [ - 266 - ], - "FieldValues": [ - "Padrão" - ] - } - ], - "ProductSpecifications": [ - { - "FieldId": 7, - "FieldName": "Faixa Etária", - "FieldValueIds": [ - 58, - 56, - 55, - 52 - ], - "FieldValues": [ - "5 a 6 anos", - "7 a 8 anos", - "9 a 10 anos", - "Acima de 10 anos" - ] - }, - { - "FieldId": 23, - "FieldName": "Fabricante", - "FieldValueIds": [], - "FieldValues": [ - "Xalingo" - ] - } - ], - "ProductClustersIds": "176,187,192,194,211,217,235,242", - "ProductCategoryIds": "/59/", - "ProductGlobalCategoryId": null, - "ProductCategories": { - "59": "Brinquedos" - }, - "CommercialConditionId": 1, - "RewardValue": 100.0, - "AlternateIds": { - "Ean": "8781", - "RefId": "878181" - }, - "AlternateIdValues": [ - "8781", - "878181" - ], - "EstimatedDateArrival": "", - "MeasurementUnit": "un", - "UnitMultiplier": 1, - "InformationSource": null, - "ModalType": "" - } - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog/pvt/stockkeepingunit/{skuId}/ean": { - "get": { - "tags": [ - "SKU EAN" - ], - "summary": "Get EAN by SkuId", - "description": "Retrieves the EAN of the SKU", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": "SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - }, - "delete": { - "tags": [ - "SKU EAN" - ], - "summary": "Delete all SKU EAN", - "description": "Deletes all EANs values of an SKU", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": "SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/stockkeepingunit/{skuId}/ean/{ean}": { - "post": { - "tags": [ - "SKU EAN" - ], - "summary": "Create SKU EAN", - "description": "Creates or updates the EAN value of an SKU", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": "SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "ean", - "in": "path", - "required": true, - "description": "EAN number", - "schema": { - "type": "integer", - "default": 1234567 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - }, - "delete": { - "tags": [ - "SKU EAN" - ], - "summary": "Delete SKU EAN", - "description": "Deletes the EAN value of an SKU", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": "SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "ean", - "in": "path", - "required": true, - "description": "EAN number", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/skuattachment": { - "post": { - "tags": [ - "SKU Attachment" - ], - "summary": "Associate SKU Attachment", - "description": "Associates an existing SKU to an existing Attachment", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "required": [ - "AttachmentId", - "SkuId" - ], - "properties": { - "AttachmentId": { - "type": "integer", - "title": "AttachmentId", - "description": "Attachment ID", - "default": 0 - }, - "SkuId": { - "type": "integer", - "title": "SkuId", - "description": "Unique identifier of an SKU", - "default": 0 - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "SKU Attachment" - ], - "summary": "Delete SKU Attachment by SkuId", - "description": "Deletes an association of an SKU to an Attachment by its Attachment ID", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "attachmentId", - "in": "query", - "description": "SKU’s unique numerical identifier", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/stockkeepingunit/{skuId}/attachment": { - "get": { - "tags": [ - "SKU Attachment" - ], - "summary": "Get SKU Attachment by SKU ID", - "description": "Retrives an existing SKU Attachment from a SKU by its ID", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": "SKU unique identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/skuattachment/{attachmentId}": { - "delete": { - "tags": [ - "SKU Attachment" - ], - "summary": "Delete SKU Attachment by AttachmentId", - "description": "Deletes an association of an SKU to an Attachment", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "attachmentId", - "in": "path", - "required": true, - "description": "Attachment’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/skuattachment/{skuAttachmentAssociationId}": { - "delete": { - "tags": [ - "SKU Attachment" - ], - "summary": "Delete SKU Attachment by SKU Attachment Association ID", - "description": "Deletes an association of an SKU to an Attachment", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuAttachmentAssociationId", - "in": "path", - "required": true, - "description": "SKU Attachment Association ID", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog_system/pvt/sku/associateattachments": { - "post": { - "tags": [ - "SKU Attachment" - ], - "summary": "Associate attachments to SKU", - "description": "Amplifies a cart data by associating attachments to SKUs.\n\rThis request removes existing SKU attachment associations and recreates the associations with the attachments being sent.", - "operationId": "AssociateattachmentstoSKU", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AssociateattachmentstoSKURequest" - }, - "example": { - "SkuId": 1622, - "AttachmentId": [ - 1, - 2 - ] - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": {} - } - }, - "deprecated": false - } - }, - "/api/catalog/pvt/skuattachment/{skuAttachmentId}": { - "delete": { - "tags": [ - "SKU Attachment" - ], - "summary": "Delete SKU Complement", - "description": "Deletes a previously existing Complement of an SKU", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuAttachmentId", - "in": "path", - "required": true, - "description": "Attachment’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "required": [ - "ParentSkuId", - "SkuId", - "ComplementTypeId" - ], - "properties": { - "ParentSkuId": { - "type": "integer", - "title": "ParentSkuId", - "description": "SKU in which you are inserting the Complement", - "default": 1 - }, - "SkuId": { - "type": "integer", - "title": "SkuId", - "description": "SKU in which you are inserting as a Complement in the Parent SKU", - "default": 1 - }, - "ComplementTypeId": { - "type": "integer", - "title": "ComplementTypeId", - "description": "Type of the complement you are inserting on the SKU. The possible values are: `1` to *assessor*; `2` to *suggestion*; `3` to *similar*; 5 to *show together*.", - "default": 1 - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/stockkeepingunit/{skuId}/file": { - "get": { - "tags": [ - "SKU File" - ], - "summary": "Get SKU File", - "description": "Gets general information about all Files inside the SKU", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": "SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - }, - "post": { - "tags": [ - "SKU File" - ], - "summary": "Create SKU File", - "description": "Creates a new Image on an SKU based on its URL or on a form-data request body", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": "SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 123456 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "Id": 625, - "ArchiveId": 155569, - "SkuId": 123456, - "IsMain": true, - "Label": "Main" - }, - "schema": { - "type": "object", - "title": "", - "properties": { - "Id": { - "type": "integer", - "description": "ID of the association of the SKU and the image (`SkuFileId`). This is the ID that is used to update or delete it." - }, - "ArchiveId": { - "type": "integer", - "description": "Unique identifier of the image file." - }, - "SkuId": { - "type": "integer", - "description": "SKU ID." - }, - "IsMain": { - "type": "boolean", - "description": "Set the image as the main image for the product." - }, - "Label": { - "type": "string", - "description": "Image label." - } - } - } - } - } - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SKUFileURL" - } - }, - "form-data": { - "schema": { - "$ref": "#/components/schemas/SKUFile" - } - } - } - } - }, - "delete": { - "tags": [ - "SKU File" - ], - "summary": "Delete All SKU File", - "description": "Deletes all SKU Image Files", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": "SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/stockkeepingunit/{skuId}/file/{skuFileId}": { - "put": { - "tags": [ - "SKU File" - ], - "summary": "Update SKU File", - "description": "Updates a new Image on an SKU based on its URL or on a form-data request body.", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": "SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 123456 - } - }, - { - "name": "skuFileId", - "in": "path", - "required": true, - "description": "SKU File’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 155569 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "Id": 625, - "ArchiveId": 155569, - "SkuId": 123456, - "IsMain": true, - "Label": "Main" - }, - "schema": { - "type": "object", - "title": "", - "properties": { - "Id": { - "type": "integer", - "description": "ID of the association of the SKU and the image (`SkuFileId`). This is the ID that is used to update or delete it." - }, - "ArchiveId": { - "type": "integer", - "description": "Unique identifier of the image file." - }, - "SkuId": { - "type": "integer", - "description": "SKU ID." - }, - "IsMain": { - "type": "boolean", - "description": "Set the image as the main image for the product." - }, - "Label": { - "type": "string", - "description": "Image label." - } - } - } - } - } - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SKUFileURL" - } - } - } - } - }, - "delete": { - "tags": [ - "SKU File" - ], - "summary": "Delete SKU Image by File ID", - "description": "Deletes a specific SKU Image File", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": "SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "skuFileId", - "in": "path", - "required": true, - "description": "SKU File’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/stockkeepingunit/copy/{skuIdfrom}/{skuIdto}/file/": { - "put": { - "tags": [ - "SKU File" - ], - "summary": "Copy All Files from an SKU to other SKU", - "description": "Copy all existing files from an SKU to other SKU", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuIdfrom", - "in": "path", - "required": true, - "description": "SKU’s unique numerical identifier __Origin__", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "skuIdto", - "in": "path", - "required": true, - "description": "SKU’s unique numerical identifier __Destiny__", - "schema": { - "type": "integer", - "default": 2 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/stockkeepingunit/disassociate/{skuId}/file/{skuFileId}": { - "delete": { - "tags": [ - "SKU File" - ], - "summary": "Disassociate SKU File", - "description": "Disassociates an SKU File from an SKU", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": "SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "skuFileId", - "in": "path", - "required": true, - "description": "SKU File's unique numerical identifier", - "schema": { - "type": "integer", - "default": 32 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/stockkeepingunitkit": { - "get": { - "tags": [ - "SKU Kit" - ], - "summary": "Get SKU Kit by SKU ID or Parent SKU ID", - "description": "Retrieves general information about the components of an SKU Kit by SKU ID or Parent SKU ID", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "query", - "description": "SKU’s unique numerical identifier", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 1 - } - }, - { - "name": "parentSkuId", - "in": "query", - "description": "Parent SKU’s unique numerical identifier", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - }, - "post": { - "tags": [ - "SKU Kit" - ], - "summary": "Create SKU Kit", - "description": "Creates new component to a specific Kit", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "required": [ - "StockKeepingUnitParent", - "StockKeepingUnitId", - "Quantity", - "UnitPrice" - ], - "properties": { - "StockKeepingUnitParent": { - "type": "integer", - "title": "StockKeepingUnitParent", - "description": "SKU ID of the Kit SKU", - "default": 31018373 - }, - "StockKeepingUnitId": { - "type": "integer", - "title": "StockKeepingUnitId", - "description": "Component SKU ID", - "default": 31018374 - }, - "Quantity": { - "type": "integer", - "title": "Quantity", - "description": "SKU unit quantity", - "default": 31018373 - }, - "UnitPrice": { - "type": "number", - "title": "UnitPrice", - "description": "SKU unit price", - "default": 15.5 - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "SKU Kit" - ], - "summary": "Delete SKU Kit by SKU ID or Parent SKU ID", - "description": "Deletes all Kit’s components based on the Parent SKU ID or deletes a specific Kit’s component based on the SKU ID", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "query", - "description": "SKU’s unique numerical identifier", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 1 - } - }, - { - "name": "parentSkuId", - "in": "query", - "description": "Parent SKU’s unique numerical identifier", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/stockkeepingunitkit/{kitId}": { - "get": { - "tags": [ - "SKU Kit" - ], - "summary": "Get SKU Kit", - "description": "Retrieves general information about a component of a Kit", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "kitId", - "in": "path", - "required": true, - "description": "Kit’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - }, - "delete": { - "tags": [ - "SKU Kit" - ], - "summary": "Delete SKU Kit by KitId", - "description": "Deletes a specific Kit’s component based on its Kit ID", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "kitId", - "in": "path", - "required": true, - "description": "Kit’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog_system/pvt/skuseller/{sellerId}/{sellerSkuId}": { - "get": { - "tags": [ - "SKU Seller" - ], - "summary": "Get SKU seller", - "description": "Retrieves the details of a seller's SKU by its ID.", - "operationId": "GetSKUseller", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "sellerId", - "in": "path", - "description": "ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID.", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - }, - { - "name": "sellerSkuId", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetSKUseller" - }, - "example": { - "IsPersisted": true, - "IsRemoved": false, - "SkuSellerId": 799, - "SellerId": "myseller", - "StockKeepingUnitId": 50, - "SellerStockKeepingUnitId": "502", - "IsActive": true, - "UpdateDate": "2018-10-11T04:52:42.1", - "RequestedUpdateDate": null - } - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pvt/skuseller/remove/{sellerId}/{sellerSkuId}": { - "post": { - "tags": [ - "SKU Seller" - ], - "summary": "Delete an SKU seller association", - "description": "Remove the Seller SKU binding", - "operationId": "DeleteSKUsellerassociation", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "sellerId", - "in": "path", - "description": "ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID.", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - }, - { - "name": "sellerSkuId", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {} - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pvt/skuseller/changenotification/{sellerId}/{sellerSkuId}": { - "post": { - "tags": [ - "SKU Seller" - ], - "summary": "Change Notification with Seller ID and Seller SKU ID", - "description": "The seller is responsible for suggesting new SKUs to be sold in the VTEX marketplace and also for informing the marketplace about changes in their SKUs that already exist in the marketplace. Both actions start with a catalog notification, which is made by this request./n/nWith this notification, the seller is telling the marketplace that something has changed about a specific SKU, like price or inventory, or that this is a new SKU that the seller would like to offer to the marketplace.\n\nThere are two information expected by the marketplace in this request: the `sellerId`, which identifies the seller, and the `sellerSkuId`, which identifies the binding of the seller with the SKU.\n\nBoth information are passed through the request URL. The body of the request should be empty.", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "sellerId", - "in": "path", - "description": "ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID.", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - }, - { - "name": "sellerSkuId", - "in": "path", - "description": "ID of the binding of the seller with the SKU.", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "No Content", - "headers": {} - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pvt/skuseller/changenotification/{skuId}": { - "post": { - "tags": [ - "SKU Seller" - ], - "summary": "Change Notification with SKU ID", - "description": "The seller is responsible for suggesting new SKUs to be sold in the VTEX marketplace and also for informing the marketplace about changes in their SKUs that already exist in the marketplace. Both actions start with a catalog notification, which is made by this request./n/nWith this notification, the seller is telling the marketplace that something has changed about a specific SKU, like price or inventory, or that this is a new SKU that the seller would like to offer to the marketplace.\n\nThe body of the request should be empty.", - "operationId": "ChangeNotification", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "description": "A string that identifies the SKU in the marketplace. This is the ID that the marketplace will use to look for the SKU whose change the seller wants to inform. If the marketplace finds this ID, it responds with status code 200. Otherwise, it responds with status code 404.", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {} - } - }, - "deprecated": false - } - }, - "/api/catalog/pvt/skuservice/{skuServiceId}": { - "put": { - "tags": [ - "SKU Service" - ], - "summary": "Update SKU Service", - "description": "Updates an SKU Service from an SKU", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuServiceId", - "in": "path", - "required": true, - "description": "SKU Service unique identifier", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "required": [ - "SkuServiceTypeId", - "SkuServiceValueId", - "SkuId", - "Name", - "Text", - "IsActive" - ], - "properties": { - "SkuServiceTypeId": { - "type": "integer", - "title": "SkuServiceTypeId", - "description": "SKU Service Type ID", - "default": 2 - }, - "SkuServiceValueId": { - "type": "integer", - "title": "SkuServiceValueId", - "description": "SKU Service Value ID", - "default": 1 - }, - "SkuId": { - "type": "integer", - "title": "SkuId", - "description": "SKU ID", - "default": 1 - }, - "Name": { - "type": "string", - "title": "Name", - "description": "SKU Service Name. Maximum of 50 characters", - "default": "Test name" - }, - "Text": { - "type": "string", - "title": "Text", - "description": "Internal description for the SKU Service. Maximum of 100 characters", - "default": "Text" - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "If the SKU Service is active or not", - "default": true - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "SKU Service" - ], - "summary": "Dissociate SKU Service", - "description": "Dissociates an SKU Service from an SKU", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuServiceId", - "in": "path", - "required": true, - "description": "SKU Service unique identifier", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/skuservice": { - "post": { - "tags": [ - "SKU Service" - ], - "summary": "Associate SKU Service", - "description": "Associates an SKU Service to an SKU", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "required": [ - "SkuServiceTypeId", - "SkuServiceValueId", - "SkuId", - "Name", - "Text", - "IsActive" - ], - "properties": { - "SkuServiceTypeId": { - "type": "integer", - "title": "SkuServiceTypeId", - "description": "SKU Service Type ID", - "default": 2 - }, - "SkuServiceValueId": { - "type": "integer", - "title": "SkuServiceValueId", - "description": "SKU Service Value ID", - "default": 1 - }, - "SkuId": { - "type": "integer", - "title": "SkuId", - "description": "SKU ID", - "default": 1 - }, - "Name": { - "type": "string", - "title": "Name", - "description": "SKU Service Name. Maximum of 50 characters", - "default": "Test name" - }, - "Text": { - "type": "string", - "title": "Text", - "description": "Internal description for the SKU Service. Maximum of 100 characters", - "default": "Text" - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "If the SKU Service is active or not", - "default": true - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/skuservicetypeattachment": { - "post": { - "tags": [ - "SKU Service Attachment" - ], - "summary": "Associate SKU Service Attachment", - "description": "Associates an Attachment for an existing SKU Service Type", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "required": [ - "AttachmentId", - "SkuServiceTypeId" - ], - "properties": { - "AttachmentId": { - "type": "integer", - "title": "AttachmentId", - "description": "Attachment ID", - "default": 1 - }, - "SkuServiceTypeId": { - "type": "integer", - "title": "SkuServiceTypeId", - "description": "An explanation about the purpose of this instance.", - "default": 1 - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "SKU Service Attachment" - ], - "summary": "Dissociate Attachment by Attachment ID or SKU Service Type ID", - "description": "Dissociates an Attachment by its Attachment ID or SKU Service Type ID from an SKU Service Type", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "attachmentId", - "in": "query", - "required": false, - "description": "SKU Service Attachment unique identifier", - "schema": { - "type": "integer" - } - }, - { - "name": "skuServiceTypeId", - "in": "query", - "required": false, - "description": "SKU Service Type unique identifier", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/skuservicetypeattachment/{skuServiceTypeAttachmentId}": { - "delete": { - "tags": [ - "SKU Service Attachment" - ], - "summary": "Dissociate Attachment from SKU Service Type", - "description": "Dissociates an Attachment from an SKU Service Type", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuServiceTypeAttachmentId", - "in": "path", - "required": true, - "description": "SKU Service Attachment unique identifier", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/skuservicetype": { - "post": { - "tags": [ - "SKU Service Type" - ], - "summary": "Create SKU Service Type", - "description": "Creates an SKU Service Type from scratch", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "default": {}, - "required": [ - "Name", - "IsActive", - "ShowOnProductFront", - "ShowOnCartFront", - "ShowOnAttachmentFront", - "ShowOnFileUpload", - "IsGiftCard", - "IsRequired" - ], - "properties": { - "Name": { - "type": "string", - "title": "Name", - "description": "SKU Service Type Name. Maximum of 100 characters", - "default": "Test API Sku Services" - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "If the SKU Service Type is active or not", - "default": true - }, - "ShowOnProductFront": { - "type": "boolean", - "title": "ShowOnProductFront", - "description": "Deprecated", - "deprecated": true - }, - "ShowOnCartFront": { - "type": "boolean", - "title": "ShowOnCartFront", - "description": "If the SKU Service Type is displayed on the cart screen", - "default": false - }, - "ShowOnAttachmentFront": { - "type": "boolean", - "title": "ShowOnAttachmentFront", - "description": "If the SKU Service Type has an attachment", - "default": false - }, - "ShowOnFileUpload": { - "type": "boolean", - "title": "ShowOnFileUpload", - "description": "If the SKU Service Type can be associated with an attachment or not", - "default": false - }, - "IsGiftCard": { - "type": "boolean", - "title": "IsGiftCard", - "description": "If the SKU Service Type is displayed as a Gift Card", - "default": false - }, - "IsRequired": { - "type": "boolean", - "title": "IsRequired", - "description": "If the SKU Service type mandatory", - "default": false - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/skuservicetype/{skuServiceTypeId}": { - "put": { - "tags": [ - "SKU Service Type" - ], - "summary": "Update SKU Service Type", - "description": "Updates an existing SKU Service Type", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuServiceTypeId", - "in": "path", - "required": true, - "description": "SKU Service Type unique identifier", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "required": [ - "Name", - "IsActive", - "ShowOnProductFront", - "ShowOnCartFront", - "ShowOnAttachmentFront", - "ShowOnFileUpload", - "IsGiftCard", - "IsRequired" - ], - "properties": { - "Name": { - "type": "string", - "title": "Name", - "description": "SKU Service Type Name. Maximum of 100 characters", - "default": "Test API Sku Services" - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "If the SKU Service Type is active or not", - "default": true - }, - "ShowOnProductFront": { - "type": "boolean", - "title": "ShowOnProductFront", - "description": "Deprecated", - "deprecated": true - }, - "ShowOnCartFront": { - "type": "boolean", - "title": "ShowOnCartFront", - "description": "If the SKU Service Type is displayed on the cart screen", - "default": false - }, - "ShowOnAttachmentFront": { - "type": "boolean", - "title": "ShowOnAttachmentFront", - "description": "If the SKU Service Type has an attachment", - "default": false - }, - "ShowOnFileUpload": { - "type": "boolean", - "title": "ShowOnFileUpload", - "description": "If the SKU Service Type can be associated with an attachment or not", - "default": false - }, - "IsGiftCard": { - "type": "boolean", - "title": "IsGiftCard", - "description": "If the SKU Service Type is displayed as a Gift Card", - "default": false - }, - "IsRequired": { - "type": "boolean", - "title": "IsRequired", - "description": "If the SKU Service type mandatory", - "default": false - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "SKU Service Type" - ], - "summary": "Delete SKU Service Type", - "description": "Deletes an existing SKU Service Type", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuServiceTypeId", - "in": "path", - "required": true, - "description": "SKU Service Type unique identifier", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/skuservicevalue": { - "post": { - "tags": [ - "SKU Service Value" - ], - "summary": "Create SKU Service Value", - "description": "Creates an SKU Service Value for an existing SKU Service Type", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "required": [ - "SkuServiceTypeId", - "Name", - "Value", - "Cost" - ], - "properties": { - "SkuServiceTypeId": { - "type": "integer", - "title": "SkuServiceTypeId", - "description": "SKU Service Type ID", - "default": 2 - }, - "Name": { - "type": "string", - "title": "Name", - "description": "SKU Service Value name. Maximum of 100 characters", - "default": "Test ServiceValue API" - }, - "Value": { - "type": "number", - "title": "Value", - "description": "SKU Service Value value", - "default": 10.5 - }, - "Cost": { - "type": "number", - "title": "Cost", - "description": "SKU Service Value cost", - "default": 10.5 - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/skuservicevalue/{skuServiceValueId}": { - "put": { - "tags": [ - "SKU Service Value" - ], - "summary": "Update SKU Service Value", - "description": "Updates an existing SKU Service Value", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuServiceValueId", - "in": "path", - "required": true, - "description": "SKU Service Value unique identifier", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "required": [ - "SkuServiceTypeId", - "Name", - "Value", - "Cost" - ], - "properties": { - "SkuServiceTypeId": { - "type": "integer", - "title": "SkuServiceTypeId", - "description": "SKU Service Type ID", - "default": 2 - }, - "Name": { - "type": "string", - "title": "Name", - "description": "SKU Service Value name. Maximum of 100 characters", - "default": "Test ServiceValue API" - }, - "Value": { - "type": "number", - "title": "Value", - "description": "SKU Service Value value", - "default": 10.5 - }, - "Cost": { - "type": "number", - "title": "Cost", - "description": "SKU Service Value cost", - "default": 10.5 - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "SKU Service Value" - ], - "summary": "Delete SKU Service Value", - "description": "Deletes an existing SKU Service Value", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuServiceValueId", - "in": "path", - "required": true, - "description": "SKU Service Value unique identifier", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/stockkeepingunit/{skuId}/specification": { - "get": { - "tags": [ - "SKU Specification" - ], - "summary": "Get SKU Specifications", - "description": "Retrieves general information about an SKU Specification", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": "SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - }, - "post": { - "tags": [ - "SKU Specification" - ], - "summary": "Associate SKU Specification", - "description": "Associates a previously defined Specification to an SKU", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": "SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1234568387 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "Id": 1505, - "SkuId": 1234568387, - "FieldId": 193, - "FieldValueId": 360, - "Text": "Size 10" - }, - "schema": { - "type": "object", - "title": "", - "properties": { - "Id": { - "type": "integer", - "description": "ID of the association of the specification and the SKU. This ID is used to update or delete the specification." - }, - "SkuId": { - "type": "integer", - "description": "SKU ID." - }, - "FieldId": { - "type": "integer", - "description": "Specification ID." - }, - "FieldValueId": { - "type": "integer", - "description": "Specification Value ID. Required only for `FieldTypeId` as `5`, `6` and `7`." - }, - "Text": { - "type": "string", - "description": "Value of specification. Only for `FieldTypeId` different from `5`, `6` and `7`." - } - } - } - } - } - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "", - "required": [ - "FieldId" - ], - "properties": { - "FieldId": { - "type": "integer", - "title": "FieldId", - "description": "Specification ID.", - "example": 13 - }, - "FieldValueId": { - "type": "integer", - "title": "FieldValueId", - "description": "Specification Value ID. Required only for `FieldTypeId` as `5`, `6` and `7`.", - "example": 101 - } - } - } - } - } - } - }, - "put": { - "tags": [ - "SKU Specification" - ], - "summary": "Update SKU Specification", - "description": "Updates an existing Specification on an existing SKU. This endpoint only updates the `FieldValueId`", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": "SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 21 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request Body", - "required": [ - "Id", - "FieldId", - "FieldValueId" - ], - "properties": { - "Id": { - "type": "integer", - "title": "Id", - "description": "Specification and SKU association unique identifier. This field cannot be updated", - "default": 65 - }, - "SkuId": { - "type": "integer", - "title": "SkuId", - "description": "SKU unique identifier. This field cannot be updated", - "default": 21 - }, - "FieldId": { - "type": "integer", - "title": "FieldId", - "description": "Specification unique identifier. This field cannot be updated", - "default": 32 - }, - "FieldValueId": { - "type": "integer", - "title": "FieldValueId", - "description": "Specification value unique identifier. This field can only be updated with other values of the same `FieldId`", - "default": 131 - }, - "Text": { - "type": "string", - "title": "Text", - "description": "Specification Value Name. This field is automatically updated if the `FieldValue` is updated. Otherwise, the value cannot be modified", - "default": "Red" - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "SKU Specification" - ], - "summary": "Delete all SKU Specifications", - "description": "Deletes all Product Specifications", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": "SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/stockkeepingunit/{skuId}/specification/{specificationId}": { - "delete": { - "tags": [ - "SKU Specification" - ], - "summary": "Delete SKU Specification", - "description": "Deletes a specific SKU Specification", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": "SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "specificationId", - "in": "path", - "required": true, - "description": "Specification’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/subcollection/{subCollectionId}/stockkeepingunit": { - "get": { - "tags": [ - "SKU Subcollection" - ], - "summary": "Get Subcollection's SKUs", - "description": "Retrieves all SKUs from a Subcollection", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "subCollectionId", - "in": "path", - "required": true, - "description": "Subcollection’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "page", - "in": "query", - "required": true, - "description": "Page number", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "size", - "in": "query", - "required": true, - "description": "Number of items in a page", - "schema": { - "type": "integer", - "default": 50 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - }, - "post": { - "tags": [ - "SKU Subcollection" - ], - "summary": "Associate SubCollection to SKU", - "description": "Associates a SubCollection to a single SKU", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "subCollectionId", - "in": "path", - "required": true, - "description": "Subcollection’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "required": [ - "SkuId" - ], - "properties": { - "SkuId": { - "type": "integer", - "title": "SkuId", - "description": "Unique identifier of an SKU", - "default": 0 - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/subcollection/{subCollectionId}/stockkeepingunit/{skuId}": { - "delete": { - "tags": [ - "SKU Subcollection" - ], - "summary": "Delete SKU SubCollection", - "description": "Deletes an SKU from a SubCollection", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "subCollectionId", - "in": "path", - "required": true, - "description": "Subcollection’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "skuId", - "in": "path", - "required": true, - "description": "SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog_system/pub/category/tree/{categoryLevels}": { - "get": { - "tags": [ - "Category" - ], - "summary": "Get Category Tree", - "description": "Retrieves the Category Tree of your store. Get all the category levels registered in the Catalog or define the level up to which you want to get.", - "operationId": "CategoryTree", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "categoryLevels", - "in": "path", - "required": true, - "description": "Value of the category level you need to retrieve", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "headers": { - "Cache-Control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Connection": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "keep-alive" - } - } - }, - "Content-Encoding": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "gzip" - } - } - }, - "Content-Length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "1860" - } - } - }, - "Date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Mon, 13 Feb 2017 15:01:58 GMT" - } - } - }, - "Expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-1" - } - } - }, - "Pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "nginx" - } - } - }, - "Vary": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Accept-Encoding" - } - } - }, - "X-CacheServer": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "janus-apicache-nginx3" - } - } - }, - "X-Powered-by-VTEX-Janus-ApiCache": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "v1.3.9" - } - } - }, - "X-Powered-by-VTEX-Janus-Edge": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "v1.35.3" - } - } - }, - "X-Track": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "stable" - } - } - }, - "X-VTEX-Cache-Status-Janus-ApiCache": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "EXPIRED" - } - } - }, - "X-VTEX-Cache-Status-Janus-Edge": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "MISS" - } - } - }, - "X-VTEX-Janus-Router-Backend-App": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "prtapi-v1.4.683-stable+527" - } - } - }, - "no": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-QTBJG9KGSVN" - } - } - }, - "p3p": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "policyref=\"/w3c/p3p.xml\",CP=\"ADMa OUR NOR CNT NID DSP NOI COR\"" - } - } - }, - "powered": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "vtex" - } - } - }, - "x-vtex-operation-id": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "ee99c29c-5b98-4fd1-855d-56a5e9e4d233" - } - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Example1" - } - }, - "example": [ - { - "id": 77, - "name": "Games", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/games", - "children": [ - { - "id": 78, - "name": "Xbox 360", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/games/xbox-360", - "children": [ - { - "id": 79, - "name": "Consoles", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/games/xbox-360/consoles", - "children": [] - }, - { - "id": 126, - "name": "Acessorio", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/games/xbox-360/acessorio", - "children": [] - } - ] - }, - { - "id": 132, - "name": "PS4", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/games/ps4", - "children": [] - } - ] - }, - { - "id": 1, - "name": "Departamento 1", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-1", - "children": [ - { - "id": 2, - "name": "Categoria 1-1", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-1/categoria-1-1", - "children": [ - { - "id": 4, - "name": "SubCategoria 1-1-1", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-1/categoria-1-1/subcategoria-1-1-1", - "children": [] - }, - { - "id": 15, - "name": "SubCategoria 1-1-2", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-1/categoria-1-1/subcategoria-1-1-2", - "children": [] - }, - { - "id": 16, - "name": "SubCategoria 1-1-3", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-1/categoria-1-1/subcategoria-1-1-3", - "children": [] - }, - { - "id": 18, - "name": "SubCategoria 1-1-4", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-1/categoria-1-1/subcategoria-1-1-4", - "children": [] - } - ] - }, - { - "id": 19, - "name": "Categoria 1-2", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-1/categoria-1-2", - "children": [] - }, - { - "id": 20, - "name": "Categoria 1-3", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-1/categoria-1-3", - "children": [] - }, - { - "id": 34, - "name": "teste", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-1/teste", - "children": [] - }, - { - "id": 61, - "name": "sub departamento", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-1/sub-departamento", - "children": [] - } - ] - }, - { - "id": 45, - "name": "Departamento de Testes Ramon 4", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-de-testes-ramon-4", - "children": [ - { - "id": 46, - "name": "Departamento de Testes Ramon 4 Filho", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-de-testes-ramon-4/departamento-de-testes-ramon-4-filho", - "children": [] - } - ] - }, - { - "id": 3, - "name": "Departamento 2", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-2", - "children": [ - { - "id": 5, - "name": "Categoria 2-1", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-2/categoria-2-1", - "children": [ - { - "id": 6, - "name": "SubCategoria 2-1-1", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-2/categoria-2-1/subcategoria-2-1-1", - "children": [] - }, - { - "id": 17, - "name": "SubCategoria 2-1-2", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-2/categoria-2-1/subcategoria-2-1-2", - "children": [] - } - ] - }, - { - "id": 21, - "name": "Categoria 2-2", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-2/categoria-2-2", - "children": [] - }, - { - "id": 23, - "name": "Categoria 2-3", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-2/categoria-2-3", - "children": [] - } - ] - }, - { - "id": 7, - "name": "Departamento 3", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-3", - "children": [ - { - "id": 8, - "name": "Categoria 3-1", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-3/categoria-3-1", - "children": [] - }, - { - "id": 22, - "name": "Categoria 3-2", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-3/categoria-3-2", - "children": [] - }, - { - "id": 24, - "name": "Categoria 3-3", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-3/categoria-3-3", - "children": [] - } - ] - }, - { - "id": 9, - "name": "Departamento 4", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-4", - "children": [ - { - "id": 10, - "name": "Categoria 4-1", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-4/categoria-4-1", - "children": [ - { - "id": 11, - "name": "SubCategoria 4-1-1", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-4/categoria-4-1/subcategoria-4-1-1", - "children": [] - } - ] - }, - { - "id": 25, - "name": "Categoria 4-2", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-4/categoria-4-2", - "children": [] - }, - { - "id": 26, - "name": "Categoria 4-3", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-4/categoria-4-3", - "children": [] - }, - { - "id": 29, - "name": "Looks", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-4/looks", - "children": [] - } - ] - }, - { - "id": 12, - "name": "Departamento 5", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-5", - "children": [ - { - "id": 13, - "name": "Categoria 5-1", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-5/categoria-5-1", - "children": [ - { - "id": 14, - "name": "SubCategoria 5-1-1", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-5/categoria-5-1/subcategoria-5-1-1", - "children": [] - } - ] - }, - { - "id": 27, - "name": "Categoria 5-2", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-5/categoria-5-2", - "children": [] - }, - { - "id": 28, - "name": "Categoria 5-3", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-5/categoria-5-3", - "children": [] - } - ] - }, - { - "id": 39, - "name": "Departamento 6", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-6", - "children": [ - { - "id": 38, - "name": "Categoria 6-1", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-6/categoria-6-1", - "children": [ - { - "id": 48, - "name": "SubCategoria 6-1-1", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-6/categoria-6-1/subcategoria-6-1-1", - "children": [] - } - ] - }, - { - "id": 40, - "name": "Categoria 6-2", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-6/categoria-6-2", - "children": [] - } - ] - }, - { - "id": 32, - "name": "Departamento 7", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-7", - "children": [ - { - "id": 33, - "name": "Categoria 7-1", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-7/categoria-7-1", - "children": [] - }, - { - "id": 47, - "name": "Categoria 7-2", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-7/categoria-7-2", - "children": [] - } - ] - }, - { - "id": 35, - "name": "Departamento 8", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-8", - "children": [ - { - "id": 37, - "name": "Categoria 8-1", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-8/categoria-8-1", - "children": [] - } - ] - }, - { - "id": 43, - "name": "Departamento de Testes Ramon 3", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-de-testes-ramon-3", - "children": [] - }, - { - "id": 49, - "name": "Departamento para Teste Automação", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-para-teste-automacao", - "children": [] - }, - { - "id": 52, - "name": "Departamento Campos Iguais", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-campos-iguais", - "children": [ - { - "id": 53, - "name": "Categoria com campos iguais", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-campos-iguais/categoria-com-campos-iguais", - "children": [ - { - "id": 55, - "name": "SubCategoria com campos iguais 1", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-campos-iguais/categoria-com-campos-iguais/subcategoria-com-campos-iguais-1", - "children": [] - }, - { - "id": 56, - "name": "SubCategoria com campos iguais 2", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-campos-iguais/categoria-com-campos-iguais/subcategoria-com-campos-iguais-2", - "children": [] - } - ] - }, - { - "id": 54, - "name": "Categoria com campos iguais 2", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-campos-iguais/categoria-com-campos-iguais-2", - "children": [ - { - "id": 57, - "name": "SubCategoria com campos iguais 2-1", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-campos-iguais/categoria-com-campos-iguais-2/subcategoria-com-campos-iguais-2-1", - "children": [] - }, - { - "id": 58, - "name": "SubCategoria com campos iguais 2-2", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-campos-iguais/categoria-com-campos-iguais-2/subcategoria-com-campos-iguais-2-2", - "children": [] - } - ] - } - ] - }, - { - "id": 59, - "name": "Brinquedos", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/brinquedos", - "children": [] - }, - { - "id": 60, - "name": "Cama, Mesa & Banho", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/cama-mesa---banho", - "children": [] - }, - { - "id": 62, - "name": "Eletrônicos", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/eletronicos", - "children": [ - { - "id": 131, - "name": "TVs", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/eletronicos/tvs", - "children": [] - } - ] - }, - { - "id": 63, - "name": "Departamento TESTE ARGOLO", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-teste-argolo", - "children": [ - { - "id": 64, - "name": "Categoria TESTE ARGOLO", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-teste-argolo/categoria-teste-argolo", - "children": [ - { - "id": 65, - "name": "Subcategoria TESTE ARGOLO", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-teste-argolo/categoria-teste-argolo/subcategoria-teste-argolo", - "children": [] - } - ] - } - ] - }, - { - "id": 66, - "name": "Departamento Musical", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-musical", - "children": [ - { - "id": 67, - "name": "Categoria Musical Estrela (Renan)", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-musical/categoria-musical-estrela--renan-", - "children": [ - { - "id": 68, - "name": "Subcategoria Musical ALTERADO", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-musical/categoria-musical-estrela--renan-/subcategoria-musical-alterado", - "children": [] - } - ] - } - ] - }, - { - "id": 69, - "name": "ARGOLO TESTE3", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/argolo-teste3", - "children": [ - { - "id": 70, - "name": "CAT ARGOLO / TESTE 22", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/argolo-teste3/cat-argolo---teste-22", - "children": [] - } - ] - }, - { - "id": 71, - "name": "Eletrodoméstico", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/eletrodomestico", - "children": [ - { - "id": 72, - "name": "Eletroportateis", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/eletrodomestico/eletroportateis", - "children": [ - { - "id": 73, - "name": "Grill", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/eletrodomestico/eletroportateis/grill", - "children": [] - }, - { - "id": 94, - "name": "Batedeira", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/eletrodomestico/eletroportateis/batedeira", - "children": [] - }, - { - "id": 96, - "name": "Liquidificador", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/eletrodomestico/eletroportateis/liquidificador", - "children": [] - }, - { - "id": 98, - "name": "KIT", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/eletrodomestico/eletroportateis/kit", - "children": [] - } - ] - } - ] - }, - { - "id": 80, - "name": "Departamento Vazio", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-vazio", - "children": [ - { - "id": 81, - "name": "Categoria Vazio", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-vazio/categoria-vazio", - "children": [] - } - ] - }, - { - "id": 83, - "name": "Investigação", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/investigacao", - "children": [ - { - "id": 95, - "name": "Sub-Investigação", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/investigacao/sub-investigacao", - "children": [] - } - ] - }, - { - "id": 85, - "name": "Instrumentos Musicais", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/instrumentos-musicais", - "children": [ - { - "id": 86, - "name": "Cordas", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/instrumentos-musicais/cordas", - "children": [ - { - "id": 87, - "name": "Guitarras", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/instrumentos-musicais/cordas/guitarras", - "children": [] - }, - { - "id": 97, - "name": "Violões", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/instrumentos-musicais/cordas/violoes", - "children": [] - } - ] - } - ] - }, - { - "id": 88, - "name": "Departamento Plus Size", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-plus-size", - "children": [] - }, - { - "id": 99, - "name": "Livros", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/livros", - "children": [ - { - "id": 100, - "name": "Didático", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/livros/didatico", - "children": [ - { - "id": 101, - "name": "Ensino Médio", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/livros/didatico/ensino-medio", - "children": [] - }, - { - "id": 102, - "name": "Educação Infantil", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/livros/didatico/educacao-infantil", - "children": [] - } - ] - }, - { - "id": 103, - "name": "Ficção", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/livros/ficcao", - "children": [] - } - ] - }, - { - "id": 106, - "name": "Kits", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/kits", - "children": [ - { - "id": 107, - "name": "Padrão", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/kits/padrao", - "children": [] - } - ] - }, - { - "id": 108, - "name": "Teste Nova Categoria", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/teste-nova-categoria", - "children": [ - { - "id": 109, - "name": "Teste Nova Categoria (2)", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/teste-nova-categoria/teste-nova-categoria--2-", - "children": [] - } - ] - }, - { - "id": 117, - "name": "Petshop", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/petshop", - "children": [ - { - "id": 118, - "name": "Ração", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/petshop/racao", - "children": [] - } - ] - }, - { - "id": 127, - "name": "Ferramentas", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/ferramentas", - "children": [ - { - "id": 128, - "name": "Furadeiras", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/ferramentas/furadeiras", - "children": [] - } - ] - }, - { - "id": 129, - "name": "Roupas", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/roupas", - "children": [ - { - "id": 130, - "name": "Sapatos", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/roupas/sapatos", - "children": [] - }, - { - "id": 134, - "name": "Tênis", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/roupas/tenis", - "children": [] - } - ] - }, - { - "id": 133, - "name": "Departamento sem campos", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/departamento-sem-campos", - "children": [] - }, - { - "id": 135, - "name": "Teste Carga", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/teste-carga", - "children": [ - { - "id": 136, - "name": "PRODUTOS DA MAMBO", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/teste-carga/produtos-da-mambo", - "children": [] - } - ] - }, - { - "id": 137, - "name": "CreditControl-GiftCard-Category", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/creditcontrol-giftcard-category", - "children": [] - } - ] - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog/pvt/category/{categoryId}": { - "get": { - "tags": [ - "Category" - ], - "summary": "Get Category by ID", - "description": "Retrieves general information about a Category", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "categoryId", - "in": "path", - "required": true, - "description": "Category’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 9289 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "Id": 9289, - "Name": "Home Appliances", - "FatherCategoryId": null, - "Title": "Home Appliances", - "Description": "Discover our range of home appliances. Find smart vacuums, kitchen and laundry appliances to suit your needs. Order online now.", - "Keywords": "Kitchen, Laundry, Appliances", - "IsActive": true, - "LomadeeCampaignCode": "", - "AdWordsRemarketingCode": "", - "ShowInStoreFront": true, - "ShowBrandFilter": true, - "ActiveStoreFrontLink": true, - "GlobalCategoryId": 222, - "StockKeepingUnitSelectionMode": "SPECIFICATION", - "Score": null, - "LinkId": null, - "HasChildren": false - }, - "schema": { - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "Category ID." - }, - "Name": { - "type": "string", - "description": "Category name." - }, - "FatherCategoryId": { - "type": "integer", - "description": "ID of the father category, apply in case of category and subcategory.", - "nullable": true - }, - "Title": { - "type": "string", - "description": "Category tag title." - }, - "Description": { - "type": "string", - "description": "Describes details about the category." - }, - "Keywords": { - "type": "string", - "description": "Substitutes words for the category." - }, - "IsActive": { - "type": "boolean", - "description": "Shows if the category is active (`true`) or not (`false`)." - }, - "LomadeeCampaignCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "AdWordsRemarketingCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "ShowInStoreFront": { - "type": "boolean", - "description": "Shows if is on side and upper menu (`true`) or not (`false`)." - }, - "ShowBrandFilter": { - "type": "boolean", - "description": "If category has brand filter (`true`) or not (`false`)." - }, - "ActiveStoreFrontLink": { - "type": "boolean", - "description": "If the Category has an active link on the website (`true`) or not (`false`)." - }, - "GlobalCategoryId": { - "type": "integer", - "description": "Google Global Category ID." - }, - "StockKeepingUnitSelectionMode": { - "type": "string", - "description": "Shows how the SKU will be exhibit." - }, - "Score": { - "type": "integer", - "description": "Score for search ordination." - }, - "LinkId": { - "type": "string", - "description": "Text Link." - }, - "HasChildren": { - "type": "boolean", - "description": "If the category has a category child (`true`) or not (`false`)." - } - } - } - } - } - } - } - }, - "put": { - "tags": [ - "Category" - ], - "summary": "Update Category", - "description": "Updates a previously existing Category", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "categoryId", - "in": "path", - "required": true, - "description": "Category’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 9289 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "Id": 9289, - "Name": "Home Appliances", - "FatherCategoryId": null, - "Title": "Home Appliances", - "Description": "Discover our range of home appliances. Find smart vacuums, kitchen and laundry appliances to suit your needs. Order online now.", - "Keywords": "Kitchen, Laundry, Appliances", - "IsActive": true, - "LomadeeCampaignCode": "", - "AdWordsRemarketingCode": "", - "ShowInStoreFront": true, - "ShowBrandFilter": true, - "ActiveStoreFrontLink": true, - "GlobalCategoryId": 222, - "StockKeepingUnitSelectionMode": "SPECIFICATION", - "Score": null, - "LinkId": null, - "HasChildren": false - }, - "schema": { - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "Category ID." - }, - "Name": { - "type": "string", - "description": "Category name." - }, - "FatherCategoryId": { - "type": "integer", - "description": "ID of the father category, apply in case of category and subcategory.", - "nullable": true - }, - "Title": { - "type": "string", - "description": "Category tag title." - }, - "Description": { - "type": "string", - "description": "Describes details about the category." - }, - "Keywords": { - "type": "string", - "description": "Substitutes words for the category." - }, - "IsActive": { - "type": "boolean", - "description": "Shows if the category is active (`true`) or not (`false`)." - }, - "LomadeeCampaignCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "AdWordsRemarketingCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "ShowInStoreFront": { - "type": "boolean", - "description": "Shows if is on side and upper menu (`true`) or not (`false`)." - }, - "ShowBrandFilter": { - "type": "boolean", - "description": "If category has brand filter (`true`) or not (`false`)." - }, - "ActiveStoreFrontLink": { - "type": "boolean", - "description": "If the Category has an active link on the website (`true`) or not (`false`)." - }, - "GlobalCategoryId": { - "type": "integer", - "description": "Google Global Category ID." - }, - "StockKeepingUnitSelectionMode": { - "type": "string", - "description": "Shows how the SKU will be exhibit." - }, - "Score": { - "type": "integer", - "description": "Score for search ordination." - }, - "LinkId": { - "type": "string", - "description": "Text Link." - }, - "HasChildren": { - "type": "boolean", - "description": "If the category has a category child (`true`) or not (`false`)." - } - } - } - } - } - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "Name", - "Keywords", - "Title", - "Description", - "AdWordsRemarketingCode", - "LomadeeCampaignCode", - "FatherCategoryId", - "GlobalCategoryId", - "ShowInStoreFront", - "IsActive", - "ActiveStoreFrontLink", - "ShowBrandFilter", - "Score", - "StockKeepingUnitSelectionMode" - ], - "properties": { - "Name": { - "type": "string", - "title": "Name", - "description": "Category name", - "default": "Home Appliances" - }, - "Keywords": { - "type": "string", - "title": "Keywords", - "description": "Substitute words for the Category", - "default": "Kitchen, Laundry, Appliances" - }, - "Title": { - "type": "string", - "title": "Title", - "description": "Text used in title tag for Category page", - "default": "Home Appliances" - }, - "Description": { - "type": "string", - "title": "Description", - "description": "Text used in meta description tag for Category page", - "default": "Discover our range of home appliances. Find smart vacuums, kitchen and laundry appliances to suit your needs. Order online now." - }, - "AdWordsRemarketingCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "LomadeeCampaignCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "FatherCategoryId": { - "title": "FatherCategoryId", - "type": "integer", - "description": "ID of the parent category, apply in case of category and subcategory", - "default": 2, - "nullable": true - }, - "GlobalCategoryId": { - "type": "integer", - "title": "GlobalCategoryId", - "description": "google_product_category for Google Merchant Center", - "default": 222 - }, - "ShowInStoreFront": { - "type": "boolean", - "title": "ShowInStoreFront", - "description": "If true, Category is shown in the top and side menu", - "default": true - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "If true, Category page becomes available in store", - "default": true - }, - "ActiveStoreFrontLink": { - "type": "boolean", - "title": "ActiveStoreFrontLink", - "description": "If true, Category links become active in store", - "default": true - }, - "ShowBrandFilter": { - "type": "boolean", - "title": "ShowBrandFilter", - "description": "If true, Category page displays a Brand filter", - "default": true - }, - "Score": { - "type": "integer", - "title": "Score", - "description": "Score for search sorting order", - "default": 3 - }, - "StockKeepingUnitSelectionMode": { - "type": "string", - "title": "StockKeepingUnitSelectionMode", - "description": "Product display mode ", - "default": "SPECIFICATION" - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/category": { - "post": { - "tags": [ - "Category" - ], - "summary": "Create Category", - "description": "Creates a new Category from scratch", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "Id": 9289, - "Name": "Home Appliances", - "FatherCategoryId": null, - "Title": "Home Appliances", - "Description": "Discover our range of home appliances. Find smart vacuums, kitchen and laundry appliances to suit your needs. Order online now.", - "Keywords": "Kitchen, Laundry, Appliances", - "IsActive": true, - "LomadeeCampaignCode": "", - "AdWordsRemarketingCode": "", - "ShowInStoreFront": true, - "ShowBrandFilter": true, - "ActiveStoreFrontLink": true, - "GlobalCategoryId": 222, - "StockKeepingUnitSelectionMode": "SPECIFICATION", - "Score": null, - "LinkId": null, - "HasChildren": false - }, - "schema": { - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "Category ID." - }, - "Name": { - "type": "string", - "description": "Category name." - }, - "FatherCategoryId": { - "type": "integer", - "description": "ID of the father category, apply in case of category and subcategory.", - "nullable": true - }, - "Title": { - "type": "string", - "description": "Category tag title." - }, - "Description": { - "type": "string", - "description": "Describes details about the category." - }, - "Keywords": { - "type": "string", - "description": "Substitutes words for the category." - }, - "IsActive": { - "type": "boolean", - "description": "Shows if the category is active (`true`) or not (`false`)." - }, - "LomadeeCampaignCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "AdWordsRemarketingCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "ShowInStoreFront": { - "type": "boolean", - "description": "Shows if is on side and upper menu (`true`) or not (`false`)." - }, - "ShowBrandFilter": { - "type": "boolean", - "description": "If category has brand filter (`true`) or not (`false`)." - }, - "ActiveStoreFrontLink": { - "type": "boolean", - "description": "If the Category has an active link on the website (`true`) or not (`false`)." - }, - "GlobalCategoryId": { - "type": "integer", - "description": "Google Global Category ID." - }, - "StockKeepingUnitSelectionMode": { - "type": "string", - "description": "Shows how the SKU will be exhibit." - }, - "Score": { - "type": "integer", - "description": "Score for search ordination." - }, - "LinkId": { - "type": "string", - "description": "Text Link." - }, - "HasChildren": { - "type": "boolean", - "description": "If the category has a category child (`true`) or not (`false`)." - } - } - } - } - } - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "Name" - ], - "properties": { - "Name": { - "type": "string", - "description": "Category's Name", - "default": "Home Appliances" - }, - "Keywords": { - "type": "string", - "description": "Store Framework - Deprecated.\r\nClassic CMS - Synonyms of terms related to the name given to your department or category. \"Television\", for example, can have as a substitute word like \"TV\". This field is important to make your searches more comprehensive", - "default": "Kitchen, Laundry, Appliances" - }, - "Title": { - "type": "string", - "description": "Category's Page Title (SEO)", - "default": "Home Appliances" - }, - "Description": { - "type": "string", - "description": "Category's Meta Page Description (SEO)", - "default": "Discover our range of home appliances. Find smart vacuums, kitchen and laundry appliances to suit your needs. Order online now." - }, - "AdWordsRemarketingCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "LomadeeCampaignCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "FatherCategoryId": { - "type": "integer", - "description": "ID of the parent category, apply in case of category and subcategory", - "default": 2, - "nullable": true - }, - "GlobalCategoryId": { - "type": "integer", - "description": "[Google product category](https://support.google.com/merchants/answer/6324436?hl=en#zippy=%2Cproducts-sold-on-google%2Cshopping-ads-campaigns) for Google Merchant Center", - "default": 0 - }, - "ShowInStoreFront": { - "type": "boolean", - "description": "Store Framework - Deprecated.\r\nClassic CMS - When selecting this item, the category or department will appear in the top menu and the side menu of your store.\r\n", - "default": true - }, - "IsActive": { - "type": "boolean", - "description": "Flag to activate or deactivate category", - "default": true - }, - "ActiveStoreFrontLink": { - "type": "boolean", - "description": "Store Framework - Deprecated.\r\nClassic CMS - When selecting this item, the category or department is active and clickable on the site for the client to navigate through it.\r\n", - "default": false - }, - "ShowBrandFilter": { - "type": "boolean", - "description": "Store Framework - Deprecated.\r\nClassic CMS - When selecting this item, the category or department will have a brand filter on the page.\r\n", - "default": false - }, - "Score": { - "type": "integer", - "description": "Store Framework - Depracated\r\nValue used to set the priority on the search result page.\r\n", - "default": 3 - }, - "StockKeepingUnitSelectionMode": { - "type": "string", - "description": "Store Framework - Deprecated.\r\nClassic CMS - Product display mode = Defines how SKUs will be displayed on the product page\r\n", - "default": "SPECIFICATION" - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/product/{productId}/similarcategory/": { - "get": { - "tags": [ - "Similar Category" - ], - "summary": "Get Similar Product Category", - "description": "Retrieves Similars Categories from a Product", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "required": true, - "description": "Product’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/product/{productId}/similarcategory/{categoryId}": { - "post": { - "tags": [ - "Similar Category" - ], - "summary": "Create Similar Product Category", - "description": "Creates a Similar Category to a Product", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "required": true, - "description": "Product’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "categoryId", - "in": "path", - "required": true, - "description": "Similar Category’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - }, - "delete": { - "tags": [ - "Similar Category" - ], - "summary": "Delete Similar Product Category", - "description": "Deletes a Similar Category from a Product", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "required": true, - "description": "Product’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "categoryId", - "in": "path", - "required": true, - "description": "Similar Category’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog_system/pub/specification/field/listByCategoryId/{categoryId}": { - "get": { - "tags": [ - "Category Specification" - ], - "summary": "Get Specifications By Category Id", - "description": "Gets all specifications from a category by its ID.", - "operationId": "SpecificationsByCategoryId", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "categoryId", - "in": "path", - "description": "Category ID", - "required": true, - "style": "simple", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {} - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pub/specification/field/listTreeByCategoryId/{categoryId}": { - "get": { - "tags": [ - "Category Specification" - ], - "summary": "Get Specifications Tree By Category Id", - "description": "Lists all specifications including the current category and the level zero specifications from a category by its ID.", - "operationId": "SpecificationsTreeByCategoryId", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "categoryId", - "in": "path", - "description": "Category ID", - "required": true, - "style": "simple", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": { - "Cache-Control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Content-Length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "5495" - } - } - }, - "Date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Tue, 27 Jun 2017 00:20:50 GMT" - } - } - }, - "Expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-1" - } - } - }, - "Pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Microsoft-IIS/10.0" - } - } - }, - "X-Accel-Expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "120" - } - } - }, - "X-AspNet-Version": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "4.0.30319" - } - } - }, - "X-Powered-By": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "ASP.NET" - } - } - }, - "no": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "CELOCOUTO" - } - } - }, - "p3p": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "policyref=\"/w3c/p3p.xml\",CP=\"ADMa OUR NOR CNT NID DSP NOI COR\"" - } - } - }, - "powered": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "vtex" - } - } - }, - "x-vtex-operation-id": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "b0219ec5-86be-4474-b86e-d9c5862239f3" - } - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/example9" - } - }, - "example": [ - { - "Name": "Agenda", - "CategoryId": 1000025, - "FieldId": 822, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Bluetooth", - "CategoryId": 1000025, - "FieldId": 824, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Cámara digital", - "CategoryId": 1000025, - "FieldId": 825, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Dimensiones", - "CategoryId": 1000025, - "FieldId": 826, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Expandible a", - "CategoryId": 1000025, - "FieldId": 827, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Flash", - "CategoryId": 1000025, - "FieldId": 828, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Frecuencia", - "CategoryId": 1000025, - "FieldId": 831, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Gps", - "CategoryId": 1000025, - "FieldId": 833, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Graba video", - "CategoryId": 1000025, - "FieldId": 834, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Internet", - "CategoryId": 1000025, - "FieldId": 836, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Juegos", - "CategoryId": 1000025, - "FieldId": 838, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Libreta de contactos", - "CategoryId": 1000025, - "FieldId": 840, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Memoria interna", - "CategoryId": 1000025, - "FieldId": 841, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Otros", - "CategoryId": 1000025, - "FieldId": 842, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Pantalla resolucion", - "CategoryId": 1000025, - "FieldId": 844, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Pantalla tipo", - "CategoryId": 1000025, - "FieldId": 845, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Parlante externo", - "CategoryId": 1000025, - "FieldId": 846, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Peso", - "CategoryId": 1000025, - "FieldId": 848, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Radio", - "CategoryId": 1000025, - "FieldId": 849, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Reproduce mp3", - "CategoryId": 1000025, - "FieldId": 850, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Reproduce video", - "CategoryId": 1000025, - "FieldId": 852, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Resolución cámara", - "CategoryId": 1000025, - "FieldId": 854, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Ringtones", - "CategoryId": 1000025, - "FieldId": 856, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Sistema de mensajes", - "CategoryId": 1000025, - "FieldId": 857, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Teclado", - "CategoryId": 1000025, - "FieldId": 859, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Sistema operativo", - "CategoryId": 1000025, - "FieldId": 860, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Tipo de chip", - "CategoryId": 1000025, - "FieldId": 861, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Usb", - "CategoryId": 1000025, - "FieldId": 863, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Smartphone", - "CategoryId": 1000025, - "FieldId": 1211, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Wi-fi", - "CategoryId": 1000025, - "FieldId": 1212, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Modelo", - "CategoryId": null, - "FieldId": 5, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Origen", - "CategoryId": null, - "FieldId": 6, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Video", - "CategoryId": null, - "FieldId": 1220, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Video2", - "CategoryId": null, - "FieldId": 1221, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Video3", - "CategoryId": null, - "FieldId": 1222, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Manual", - "CategoryId": null, - "FieldId": 1223, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Datos técnicos", - "CategoryId": null, - "FieldId": 1224, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Bultos", - "CategoryId": null, - "FieldId": 1227, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "MELIID", - "CategoryId": null, - "FieldId": 1318, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Guia Rápida", - "CategoryId": null, - "FieldId": 1544, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "MELI_PRICE", - "CategoryId": null, - "FieldId": 1961, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "MELI_MIN_STOCK", - "CategoryId": null, - "FieldId": 1962, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Guía de compra 2", - "CategoryId": null, - "FieldId": 2118, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Guía de compra 3", - "CategoryId": null, - "FieldId": 2119, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Guía de compra 4", - "CategoryId": null, - "FieldId": 2120, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Guía de compra 5", - "CategoryId": null, - "FieldId": 2121, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "jugueteria electronica", - "CategoryId": null, - "FieldId": 2148, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "dia de la madre", - "CategoryId": null, - "FieldId": 2192, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Featured", - "CategoryId": null, - "FieldId": 2193, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "catTotem", - "CategoryId": null, - "FieldId": 2194, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Monto", - "CategoryId": null, - "FieldId": 2195, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Ofertas", - "CategoryId": null, - "FieldId": 2196, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Guía de compra 1", - "CategoryId": null, - "FieldId": 2198, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Electrofueguina", - "CategoryId": null, - "FieldId": 2239, - "IsActive": true, - "IsStockKeepingUnit": false - }, - { - "Name": "Envios Gratis", - "CategoryId": null, - "FieldId": 2297, - "IsActive": true, - "IsStockKeepingUnit": false - } - ] - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog/pvt/subcollection/{subCollectionId}/category": { - "post": { - "tags": [ - "Category Subcollection" - ], - "summary": "Associate SubCollection to Category", - "description": "Associates a SubCollection to a single Category", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "subCollectionId", - "in": "path", - "required": true, - "description": "Subcollection’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "required": [ - "SkuId" - ], - "properties": { - "CategoryId": { - "type": "integer", - "title": "CategoryId", - "description": "Unique identifier of a Category", - "default": 0 - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/subcollection/{subCollectionId}/brand/{categoryId}": { - "delete": { - "tags": [ - "Category Subcollection" - ], - "summary": "Delete Category SubCollection", - "description": "Deletes a Category from a SubCollection", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "subCollectionId", - "in": "path", - "required": true, - "description": "Subcollection’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "categoryId", - "in": "path", - "required": true, - "description": "Category’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog_system/pvt/brand/list": { - "get": { - "tags": [ - "Brand" - ], - "summary": "Get Brand List", - "description": "Retrieves all Brands registered in the store's Catalog.", - "operationId": "BrandList", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": [ - { - "id": 9280, - "name": "Brand", - "isActive": true, - "title": "Brand", - "metaTagDescription": "Brand", - "imageUrl": null - }, - { - "id": 2000000, - "name": "Orma Carbono", - "isActive": true, - "title": "Orma Carbon", - "metaTagDescription": "Orma Carbon", - "imageUrl": null - }, - { - "id": 2000001, - "name": "Pedigree", - "isActive": true, - "title": "Pedigree", - "metaTagDescription": "", - "imageUrl": null - }, - { - "id": 2000002, - "name": "Whiskas", - "isActive": true, - "title": "Whiskas", - "metaTagDescription": "", - "imageUrl": null - }, - { - "id": 2000003, - "name": "American Pets", - "isActive": true, - "title": "American Pets", - "metaTagDescription": "", - "imageUrl": null - }, - { - "id": 2000004, - "name": "Pipicat", - "isActive": true, - "title": "Pipicat", - "metaTagDescription": "", - "imageUrl": null - }, - { - "id": 2000005, - "name": "Petmate", - "isActive": true, - "title": "Petmate", - "metaTagDescription": "", - "imageUrl": null - }, - { - "id": 2000006, - "name": "Test'es", - "isActive": true, - "title": "asdf", - "metaTagDescription": "asdf", - "imageUrl": null - }, - { - "id": 2000007, - "name": "Multi-Marcas Moda", - "isActive": true, - "title": "", - "metaTagDescription": "", - "imageUrl": null - }, - { - "id": 2000008, - "name": "Jordan", - "isActive": true, - "title": "", - "metaTagDescription": "", - "imageUrl": "/155480/air-jordan-logo-667x500.jpg" - }, - { - "id": 2000009, - "name": "Júlia", - "isActive": true, - "title": "Júlia", - "metaTagDescription": "Uma pessoa maravilhosa", - "imageUrl": "/155484/Cat-Sleeping-Pics.jpg" - }, - { - "id": 2000010, - "name": "Nike", - "isActive": true, - "title": "", - "metaTagDescription": "nike", - "imageUrl": null - }, - { - "id": 2000011, - "name": "Teste da Karen", - "isActive": true, - "title": "", - "metaTagDescription": "", - "imageUrl": null - }, - { - "id": 2000012, - "name": "Juca", - "isActive": true, - "title": "Marca da Juca", - "metaTagDescription": "Marca da Juca", - "imageUrl": null - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "description": "An array with all brands of the store.", - "properties": { - "id": { - "type": "integer", - "description": "Brand ID." - }, - "name": { - "type": "string", - "description": "Brand name." - }, - "isActive": { - "type": "boolean", - "description": "If the brand is active (`true`) or not (`false`)." - }, - "title": { - "type": "string", - "description": "Brand title tag." - }, - "metaTagDescription": { - "type": "string", - "description": "A brief description of the brand." - }, - "imageUrl": { - "type": "string", - "description": "URL of the brand's image.", - "nullable": true - } - } - } - } - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pvt/brand/pagedlist": { - "get": { - "tags": [ - "Brand" - ], - "summary": "Get Brand List Per Page", - "description": "Retrieves all Brands registered in the store's Catalog by page number.", - "operationId": "BrandListPerPage", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "pageSize", - "in": "query", - "required": true, - "description": "Quantity of brands per page", - "schema": { - "type": "integer", - "default": 5 - } - }, - { - "name": "page", - "in": "query", - "required": true, - "description": "Page number of the brand list", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "example": { - "items": [ - { - "id": 2000000, - "name": "Farm", - "isActive": true, - "title": "Farm", - "metaTagDescription": "Farm", - "imageUrl": null - }, - { - "id": 2000001, - "name": "Adidas", - "isActive": true, - "title": "", - "metaTagDescription": "", - "imageUrl": null - }, - { - "id": 2000002, - "name": "Brastemp", - "isActive": true, - "title": "Brastemp", - "metaTagDescription": "Brastemp", - "imageUrl": null - } - ], - "paging": { - "page": 1, - "perPage": 3, - "total": 6, - "pages": 2 - } - }, - "schema": { - "type": "object", - "title": "", - "required": [ - "items", - "paging" - ], - "properties": { - "items": { - "type": "array", - "title": "items", - "description": "Array of objects with information of the store's brands.", - "default": [ - { - "id": 2000000, - "name": "Farm", - "isActive": true, - "title": "Farm", - "metaTagDescription": "Farm", - "imageUrl": null - }, - { - "id": 2000001, - "name": "Adidas", - "isActive": true, - "title": "", - "metaTagDescription": "", - "imageUrl": null - } - ], - "items": { - "type": "object", - "title": "", - "default": { - "id": 2000000, - "name": "Farm", - "isActive": true, - "title": "Farm", - "metaTagDescription": "Farm", - "imageUrl": null - }, - "required": [ - "id", - "name", - "isActive", - "title", - "metaTagDescription", - "imageUrl" - ], - "properties": { - "id": { - "type": "integer", - "title": "id", - "description": "Brand unique number identifier.", - "default": 2000000 - }, - "name": { - "type": "string", - "title": "name", - "description": "Brand name.", - "default": "Farm" - }, - "isActive": { - "type": "boolean", - "title": "isActive", - "description": "Condition if the brand is active or not.", - "default": true - }, - "title": { - "type": "string", - "title": "title", - "description": "Title shown in the browser bar, which corresponds to the title of your page.", - "default": "Farm" - }, - "metaTagDescription": { - "type": "string", - "title": "metaTagDescription", - "description": "A brief description of the brand, displayed by search engines. Since search engines can only display less than 150 characters, we recommend not exceeding this character limit when creating the description.", - "default": "Farm" - }, - "imageUrl": { - "type": "string", - "title": "imageUrl", - "description": "Brand image URL.", - "default": "", - "nullable": true - } - } - } - }, - "paging": { - "type": "object", - "title": "paging", - "description": "Object with information about the paging.", - "default": { - "page": 1, - "perPage": 3, - "total": 6, - "pages": 2 - }, - "required": [ - "page", - "perPage", - "total", - "pages" - ], - "properties": { - "page": { - "type": "integer", - "title": "page", - "description": "Page number of the brand list.", - "default": 1 - }, - "perPage": { - "type": "integer", - "title": "perPage", - "description": "Quantity of brands per page.", - "default": 3 - }, - "total": { - "type": "integer", - "title": "total", - "description": "Total of brands in the store.", - "default": 6 - }, - "pages": { - "type": "integer", - "title": "pages", - "description": "Total number of pages.", - "default": 2 - } - } - } - } - } - } - } - } - } - } - }, - "/api/catalog_system/pvt/brand/{brandId}": { - "get": { - "tags": [ - "Brand" - ], - "summary": "Get Brand", - "description": "Retrieves a specific Brand by its ID.", - "operationId": "Brand", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "brandId", - "in": "path", - "description": "Brand ID", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Brand" - }, - "example": { - "id": 7000000, - "name": "Test Brand", - "isActive": true, - "title": "Test Brand", - "metaTagDescription": "Test Brand" - } - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog/pvt/brand": { - "post": { - "tags": [ - "Brand" - ], - "summary": "Create Brand", - "description": "Creates a new Brand from scratch", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "Id": 2000013, - "Name": "Orma Carbono2", - "Text": "Orma Carbon2", - "Keywords": "orma", - "SiteTitle": "Orma Carbon2", - "Active": true, - "MenuHome": true, - "AdWordsRemarketingCode": "", - "LomadeeCampaignCode": "", - "Score": null, - "LinkId": null - }, - "schema": { - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "Brand’s numerical identifier." - }, - "Name": { - "type": "string", - "description": "Brand’s name." - }, - "Text": { - "type": "string", - "description": "Brand’s description." - }, - "Keywords": { - "type": "string", - "description": "Substitutes words for the Brand." - }, - "SiteTitle": { - "type": "string", - "description": "Brand’s page title." - }, - "Active": { - "type": "boolean", - "description": "If the Brand is active." - }, - "MenuHome": { - "type": "boolean", - "description": "If the Brand shows on the home menu or not." - }, - "AdWordsRemarketingCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "LomadeeCampaignCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "Score": { - "type": "string", - "description": "Score for search ordination.", - "nullable": true - }, - "LinkId": { - "type": "string", - "description": "Brand’s link ID.", - "nullable": true - } - } - } - } - } - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "Name" - ], - "properties": { - "Name": { - "type": "string", - "description": "Brand's name", - "default": "Adidas" - }, - "Keywords": { - "type": "string", - "description": "Store Framework - Deprecated.\r\nClassic CMS - Alternative search terms that will lead to the specific brand. The user can find the desired brand even when misspelling it. Used especially when words are of foreign origin and have a distinct spelling that is transcribed into a generic one, or when small spelling mistakes occur.\r\n", - "default": "adidas" - }, - "Text": { - "type": "string", - "title": "Text", - "description": "Brand's Meta Tag Description", - "default": "Adidas" - }, - "SiteTitle": { - "type": "string", - "title": "SiteTitle", - "description": "Brands's Page Title (SEO)", - "default": "Adidas" - }, - "AdWordsRemarketingCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "LomadeeCampaignCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "Score": { - "type": "integer", - "description": "Store Framework - Depracated\r\nValue used to set the priority on the search result page\r\n", - "default": 10 - }, - "MenuHome": { - "type": "boolean", - "title": "MenuHome", - "description": "Store Framework - Deprecated.\r\nClassic CMS - Brand appears in the Department Menu control (``)\r\n", - "default": true - }, - "Active": { - "type": "boolean", - "title": "Active", - "description": "Flag to activate or deactivate brand", - "default": true - }, - "LinkID": { - "type": "string", - "title": "LinkID", - "description": "Brand page slug", - "default": "" - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/brand/{brandId}": { - "get": { - "tags": [ - "Brand" - ], - "summary": "Get Brand and context", - "description": "Retrieves information about a specific Brand and its context", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "brandId", - "in": "path", - "description": "Brand ID", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "Id": 2000013, - "Name": "Orma Carbono2", - "Text": "Orma Carbon2", - "Keywords": "orma", - "SiteTitle": "Orma Carbon2", - "Active": true, - "MenuHome": true, - "AdWordsRemarketingCode": "", - "LomadeeCampaignCode": "", - "Score": null, - "LinkId": null - }, - "schema": { - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "Brand’s numerical identifier." - }, - "Name": { - "type": "string", - "description": "Brand’s name." - }, - "Text": { - "type": "string", - "description": "Brand’s description." - }, - "Keywords": { - "type": "string", - "description": "Substitutes words for the Brand." - }, - "SiteTitle": { - "type": "string", - "description": "Brand’s page title." - }, - "Active": { - "type": "boolean", - "description": "If the Brand is active." - }, - "MenuHome": { - "type": "boolean", - "description": "If the Brand shows on the home menu or not." - }, - "AdWordsRemarketingCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "LomadeeCampaignCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "Score": { - "type": "string", - "description": "Score for search ordination.", - "nullable": true - }, - "LinkId": { - "type": "string", - "description": "Brand’s link ID.", - "nullable": true - } - } - } - } - } - } - } - }, - "put": { - "tags": [ - "Brand" - ], - "summary": "Update Brand", - "description": "Updates a previously existing Brand", - "parameters": [ - { - "name": "brandId", - "in": "path", - "required": true, - "description": "Brand’s unique numerical identifier", - "schema": { - "type": "string", - "default": "vtexcommercestable" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "Id": 2000013, - "Name": "Orma Carbono2", - "Text": "Orma Carbon2", - "Keywords": "orma", - "SiteTitle": "Orma Carbon2", - "Active": true, - "MenuHome": true, - "AdWordsRemarketingCode": "", - "LomadeeCampaignCode": "", - "Score": null, - "LinkId": null - }, - "schema": { - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "Brand’s numerical identifier." - }, - "Name": { - "type": "string", - "description": "Brand’s name." - }, - "Text": { - "type": "string", - "description": "Brand’s description." - }, - "Keywords": { - "type": "string", - "description": "Substitutes words for the Brand." - }, - "SiteTitle": { - "type": "string", - "description": "Brand’s page title." - }, - "Active": { - "type": "boolean", - "description": "If the Brand is active." - }, - "MenuHome": { - "type": "boolean", - "description": "If the Brand shows on the home menu or not." - }, - "AdWordsRemarketingCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "LomadeeCampaignCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "Score": { - "type": "string", - "description": "Score for search ordination." - }, - "LinkId": { - "type": "string", - "description": "Brand’s link ID." - } - } - } - } - } - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "Id", - "Name", - "Keywords", - "Text", - "SiteTitle", - "AdWordsRemarketingCode", - "LomadeeCampaignCode", - "Score", - "MenuHome", - "Active", - "LinkID" - ], - "properties": { - "Id": { - "type": "string", - "title": "Id", - "description": "Brand numerical identifier", - "default": "" - }, - "Name": { - "type": "string", - "title": "Name", - "description": "Brand name", - "default": "" - }, - "Keywords": { - "type": "string", - "title": "Keywords", - "description": "Substitute words for the Brand", - "default": "" - }, - "Text": { - "type": "string", - "title": "Text", - "description": "Text used in meta description tag for Brand page", - "default": "" - }, - "SiteTitle": { - "type": "string", - "title": "SiteTitle", - "description": "Text used in title tag for Brand page", - "default": "" - }, - "AdWordsRemarketingCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "LomadeeCampaignCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "Score": { - "type": "integer", - "title": "Score", - "description": "Score for search sorting order", - "default": 10 - }, - "MenuHome": { - "type": "boolean", - "title": "MenuHome", - "description": "If true, link to Brand page will be displayed in the home menu", - "default": true - }, - "Active": { - "type": "boolean", - "title": "Active", - "description": "If true, Brand page becomes available in store", - "default": true - }, - "LinkID": { - "type": "string", - "title": "LinkID", - "description": "Brand page slug", - "default": "" - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "Brand" - ], - "summary": "Delete Brand", - "description": "Deletes an existing Brand", - "parameters": [ - { - "name": "brandId", - "in": "path", - "required": true, - "description": "Brand’s unique numerical identifier", - "schema": { - "type": "string", - "default": "vtexcommercestable" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/subcollection/{subCollectionId}/brand": { - "post": { - "tags": [ - "Brand Subcollection" - ], - "summary": "Associate SubCollection to Brand", - "description": "Associates a SubCollection to a single Brand", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "subCollectionId", - "in": "path", - "required": true, - "description": "Subcollection’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "required": [ - "SkuId" - ], - "properties": { - "BrandId": { - "type": "integer", - "title": "BrandId", - "description": "Unique identifier of a Brand", - "default": 0 - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/subcollection/{subCollectionId}/brand/{brandId}": { - "delete": { - "tags": [ - "Brand Subcollection" - ], - "summary": "Delete Brand SubCollection", - "description": "Deletes a Brand from a SubCollection", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "subCollectionId", - "in": "path", - "required": true, - "description": "Subcollection’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "brandId", - "in": "path", - "required": true, - "description": "Brand’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/attachment/{attachmentid}": { - "get": { - "tags": [ - "Attachment" - ], - "description": "Gets information about a registered attachment", - "summary": "Get attachment", - "parameters": [ - { - "name": "attachmentid", - "in": "path", - "required": true, - "description": "Attachment ID", - "schema": { - "type": "string", - "default": "vtexcommercestable" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": {} - } - } - }, - "put": { - "tags": [ - "Attachment" - ], - "description": "Updates a previously existing SKU attachment with new information", - "summary": "Update attachment", - "parameters": [ - { - "name": "attachmentid", - "in": "path", - "required": true, - "description": "Attachment ID", - "schema": { - "type": "string", - "default": "vtexcommercestable" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Resquet body", - "required": [ - "Name", - "IsRequired", - "IsActive", - "Domains" - ], - "properties": { - "Name": { - "type": "string", - "title": "Name", - "description": "Attachment Name", - "default": "Test" - }, - "IsRequired": { - "type": "boolean", - "title": "IsRequired", - "description": "If the attachment is required or not", - "default": true - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "If the attachment is active or not", - "default": true - }, - "Domains": { - "type": "array", - "title": "Domains", - "description": "Attachment list of characteristics", - "default": [], - "items": { - "required": [ - "FieldName", - "MaxCaracters", - "DomainValues" - ], - "properties": { - "FieldName": { - "type": "string", - "title": "FieldName", - "description": "Attachment key Name", - "default": "Basic test" - }, - "MaxCaracters": { - "type": "string", - "title": "MaxCaracters", - "description": "Key max number of characters", - "default": "" - }, - "DomainValues": { - "type": "string", - "title": "DomainValues", - "description": "Allowed key values", - "default": "[1-2]#9[1-1][1]basic;#11[0-1][1]basic" - } - } - } - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "Attachment" - ], - "description": "Deletes a previously existing SKU attachment", - "summary": "Delete attachment", - "parameters": [ - { - "name": "attachmentid", - "in": "path", - "required": true, - "description": "Attachment ID", - "schema": { - "type": "string", - "default": "vtexcommercestable" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": {} - } - } - } - }, - "/api/catalog/pvt/attachment": { - "post": { - "tags": [ - "Attachment" - ], - "description": "Creates a new SKU attachment from scratch", - "summary": "Create attachment", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Resquet body", - "required": [ - "Name", - "IsRequired", - "IsActive", - "Domains" - ], - "properties": { - "Name": { - "type": "string", - "title": "Name", - "description": "Attachment Name", - "default": "Test" - }, - "IsRequired": { - "type": "boolean", - "title": "IsRequired", - "description": "If the attachment is required or not", - "default": true - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "If the attachment is active or not", - "default": true - }, - "Domains": { - "type": "array", - "title": "Domains", - "description": "Attachment list of characteristics", - "default": [], - "items": { - "required": [ - "FieldName", - "MaxCaracters", - "DomainValues" - ], - "properties": { - "FieldName": { - "type": "string", - "title": "FieldName", - "description": "Attachment key Name", - "default": "Basic test" - }, - "MaxCaracters": { - "type": "string", - "title": "MaxCaracters", - "description": "Key max number of characters", - "default": "" - }, - "DomainValues": { - "type": "string", - "title": "DomainValues", - "description": "Allowed key values", - "default": "[1-2]#9[1-1][1]basic;#11[0-1][1]basic" - } - } - } - } - } - } - } - } - } - } - }, - "/api/catalog_system/pvt/collection/search": { - "get": { - "tags": [ - "Collection Beta" - ], - "summary": "Get All Collections", - "description": "Retrieves a list of all collections matching a filter", - "operationId": "GET-AllCollections", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "page", - "in": "query", - "description": "Page number", - "required": true, - "style": "form", - "schema": { - "type": "integer", - "example": 2 - } - }, - { - "name": "pageSize", - "in": "query", - "description": "Number of the items of the page", - "required": true, - "style": "form", - "schema": { - "type": "integer", - "example": 15 - } - }, - { - "name": "orderByAsc", - "in": "query", - "description": "If the items of the page are order by ascending", - "required": true, - "style": "form", - "schema": { - "type": "boolean", - "example": true - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {} - } - } - } - }, - "/api/catalog/pvt/collection/inactive": { - "get": { - "tags": [ - "Collection Beta" - ], - "summary": "Get All Inactive Collections", - "description": "Retrieves a list of Collection IDs of the inactive Collections", - "operationId": "GET-AllInactiveCollections", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {} - } - } - } - }, - "/api/catalog/pvt/collection/": { - "post": { - "tags": [ - "Collection Beta" - ], - "summary": "Create Collection", - "description": "Creates a new collection", - "operationId": "POST-CreateCollection", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "description": "", - "required": [ - "Name", - "Description", - "Searchable", - "Highlight", - "DateFrom", - "DateTo", - "TotalProducts", - "Type" - ], - "properties": { - "Name": { - "type": "string", - "title": "Name", - "description": "Collection's Name", - "default": "Halloween costumes" - }, - "Description": { - "type": "string", - "title": "Description", - "description": "Collection's description for internal use, with the collection's details. It will not be used for search engines", - "default": "HomeHalloween" - }, - "Searchable": { - "type": "boolean", - "title": "Searchable", - "description": "Option making the collection searchable in the store", - "default": false - }, - "Highlight": { - "type": "boolean", - "title": "Highlight", - "description": "Option if you want the collection to highlight specific products using a tag", - "default": false - }, - "DateFrom": { - "type": "string", - "title": "DateFrom", - "description": "Collection start date and time. If a future date and time are set, the collection will have a scheduled status", - "default": "2020-11-26T15:23:00" - }, - "DateTo": { - "type": "string", - "title": "DateTo", - "description": "Collection end date and time", - "default": "2069-11-26T15:23:00" - } - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": {} - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pvt/collection/search/{searchTerms}": { - "get": { - "tags": [ - "Collection Beta" - ], - "summary": "Get Collections by search terms", - "description": "Retrieves a list of collections matching a filter", - "operationId": "GET-Collectionsbyseachterms", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "searchTerms", - "in": "path", - "description": "String that will search for a collection related to it", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "costume" - } - }, - { - "name": "page", - "in": "query", - "description": "Page number", - "required": false, - "style": "form", - "schema": { - "type": "integer", - "example": 2 - } - }, - { - "name": "pageSize", - "in": "query", - "description": "Number of the items of the page", - "required": false, - "style": "form", - "schema": { - "type": "integer", - "example": 15 - } - }, - { - "name": "orderByAsc", - "in": "query", - "description": "If the items of the page are order by ascending", - "required": false, - "style": "form", - "schema": { - "type": "boolean", - "example": true - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {} - } - } - } - }, - "/api/catalog/pvt/collection/stockkeepingunit/importfileexample": { - "get": { - "tags": [ - "Collection Beta" - ], - "summary": "Import Collection file example", - "description": "Imports a sample of the imported XLS file. You need to save the response file to your device", - "operationId": "GET-Importfileexample", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {} - } - } - } - }, - "/api/catalog/pvt/collection/{collectionId}/stockkeepingunit/importinsert": { - "post": { - "tags": [ - "Collection Beta" - ], - "summary": "Add products to Collection by imported file", - "description": "Adds products to a collection from the request body file. The file must be an imported template", - "operationId": "POST-Addproductsbyimportfile", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "multipart/form-data" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "collectionId", - "in": "path", - "description": "Collection's unique identifier", - "required": true, - "style": "simple", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "file": { - "format": "binary", - "description": "XLS file with information about products to be added to a Collection. The file must be an imported template from [Import Collection file example](https://developers.vtex.com/vtex-developer-docs/reference/get-importfileexample) endpoint." - } - } - } - } - } - }, - "responses": { - "200": { - "description": "", - "headers": {} - } - } - } - }, - "/api/catalog/pvt/collection/{collectionId}/stockkeepingunit/importexclude": { - "post": { - "tags": [ - "Collection Beta" - ], - "summary": "Remove products from Collection by imported file", - "description": "Removes products from a collection from the request body file. The file must be an imported template", - "operationId": "POST-Removeproductsbyimportfile", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "multipart/form-data" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "collectionId", - "in": "path", - "description": "Collection's unique identifier", - "required": true, - "style": "simple", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "file": { - "format": "binary", - "description": "XLS file with information about products to be added to a Collection. The file must be an imported template from [Import Collection file example](https://developers.vtex.com/vtex-developer-docs/reference/get-importfileexample) endpoint." - } - } - } - } - } - }, - "responses": { - "200": { - "description": "", - "headers": {} - } - } - } - }, - "/api/catalog/pvt/collection/{collectionId}/products": { - "get": { - "tags": [ - "Collection Beta" - ], - "summary": "Get products from a collection", - "description": "Retrieves information about the products from a collection", - "operationId": "GET-Productsfromacollection", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "collectionId", - "in": "path", - "description": "Collection's unique identifier", - "required": true, - "style": "simple", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "page", - "in": "query", - "description": "Page number", - "required": false, - "style": "form", - "schema": { - "type": "integer", - "default": 2 - } - }, - { - "name": "pageSize", - "in": "query", - "description": "Number of the items of the page", - "required": false, - "style": "form", - "schema": { - "type": "integer", - "default": 15 - } - }, - { - "name": "Filter", - "in": "query", - "description": "Filter used to refine the Collection's products", - "required": false, - "style": "form", - "schema": { - "type": "string", - "default": "Pre launch" - } - }, - { - "name": "Active", - "in": "query", - "description": "If the status of the product is active or not", - "required": false, - "style": "form", - "schema": { - "type": "boolean", - "default": true - } - }, - { - "name": "Visible", - "in": "query", - "description": "If the product is visible on store or not", - "required": false, - "style": "form", - "schema": { - "type": "boolean", - "default": true - } - }, - { - "name": "CategoryId", - "in": "query", - "description": "Product's Category unique identifier", - "required": false, - "style": "form", - "schema": { - "type": "integer", - "default": 12 - } - }, - { - "name": "BrandId", - "in": "query", - "description": "Product's Brand unique identifier", - "required": false, - "style": "form", - "schema": { - "type": "integer", - "default": 3 - } - }, - { - "name": "SupplierId", - "in": "query", - "description": "Product's Supplier unique identifier", - "required": false, - "style": "form", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "SalesChannelId", - "in": "query", - "description": "Product's Trade Policy unique identifier", - "required": false, - "style": "form", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "ReleaseFrom", - "in": "query", - "description": "Product past release date", - "required": false, - "style": "form", - "schema": { - "type": "string", - "default": "2069-11-26T15:23:00" - } - }, - { - "name": "ReleaseTo", - "in": "query", - "description": "Product future release date", - "required": false, - "style": "form", - "schema": { - "type": "string", - "default": "2069-11-26T15:23:00" - } - }, - { - "name": "SpecificationProduct", - "in": "query", - "description": "Product Specification Field Value. You must also fill in `SpecificationFieldId` to use this parameter.", - "required": false, - "style": "form", - "schema": { - "type": "string", - "default": "M" - } - }, - { - "name": "SpecificationFieldId", - "in": "query", - "description": "Product Specification Field unique identifier", - "required": false, - "style": "form", - "schema": { - "type": "integer", - "default": 40 - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {} - } - } - } - }, - "/api/catalog/pvt/collection/{collectionId}": { - "get": { - "tags": [ - "Collection" - ], - "summary": "Get Collection", - "description": "Gets general information of a Collection", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "collectionId", - "in": "path", - "required": true, - "description": "Collection’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 151 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - }, - "put": { - "tags": [ - "Collection" - ], - "summary": "Update Collection", - "description": "Updates a previously Collection", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "collectionId", - "in": "path", - "required": true, - "description": "Collection’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 151 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Resquest body", - "required": [ - "Name", - "Searchable", - "Highlight", - "DateFrom", - "DateTo" - ], - "properties": { - "Name": { - "type": "string", - "title": "Name", - "description": "Collection Name", - "default": "Test" - }, - "Searchable": { - "type": "boolean", - "title": "Searchable", - "description": "Whether the Collection is searchale or not", - "default": true - }, - "Highlight": { - "type": "boolean", - "title": "Highlight", - "description": "If the Collection is highlighted or not", - "default": false - }, - "DateFrom": { - "type": "string", - "title": "DateFrom", - "description": "Initial value date for the Collection", - "default": "2017-09-27T10:47:00" - }, - "DateTo": { - "type": "string", - "title": "DateTo", - "description": "Final value date for the Collection", - "default": "2017-09-27T10:47:00" - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "Collection" - ], - "summary": "Delete Collection", - "description": "Deletes a previously existing Collection", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "collectionId", - "in": "path", - "required": true, - "description": "Collection’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 151 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/collection": { - "post": { - "tags": [ - "Collection CMS" - ], - "summary": "Create Collection", - "description": "Creates a new Collection", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Resquest body", - "required": [ - "Name", - "Searchable", - "Highlight", - "DateFrom", - "DateTo" - ], - "properties": { - "Name": { - "type": "string", - "title": "Name", - "description": "Collection Name", - "default": "Test" - }, - "Searchable": { - "type": "boolean", - "title": "Searchable", - "description": "Whether the Collection is searchale or not", - "default": true - }, - "Highlight": { - "type": "boolean", - "title": "Highlight", - "description": "If the Collection is highlighted or not", - "default": false - }, - "DateFrom": { - "type": "string", - "title": "DateFrom", - "description": "Initial value date for the Collection", - "default": "2017-09-27T10:47:00" - }, - "DateTo": { - "type": "string", - "title": "DateTo", - "description": "Final value date for the Collection", - "default": "2017-09-27T10:47:00" - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/collection/{collectionId}/subcollection": { - "get": { - "tags": [ - "Subcollection" - ], - "summary": "Get Subcollection by Collection ID", - "description": "Retrieves all Subcollections by its Collection ID.", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "collectionId", - "in": "path", - "required": true, - "description": "Collection’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 151 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": [ - { - "Id": 17, - "CollectionId": 151, - "Name": "group 1", - "Type": "Inclusive", - "PreSale": false, - "Release": false - }, - { - "Id": 18, - "CollectionId": 151, - "Name": "group 2", - "Type": "Inclusive", - "PreSale": false, - "Release": false - } - ], - "schema": { - "type": "array", - "title": "", - "items": { - "type": "object", - "properties": { - "Id": { - "type": "integer", - "description": "SubCollection ID." - }, - "CollectionId": { - "type": "integer", - "description": "Collection ID." - }, - "Name": { - "type": "string", - "description": "SubCollection Name." - }, - "Type": { - "type": "string", - "description": "Either `“Exclusive”` (all the products contained in it will not be used) or `“Inclusive”` (all the products contained in it will be used)." - }, - "PreSale": { - "type": "boolean", - "description": "Defines if the collection is on PreSale." - }, - "Release": { - "type": "boolean", - "description": "Defines if the collection is a new released one." - } - } - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/subcollection/{subCollectionId}": { - "get": { - "tags": [ - "Subcollection" - ], - "summary": "Get SubCollection", - "description": "Retrieves information about a SubCollection.", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "subCollectionId", - "in": "path", - "required": true, - "description": "Subcollection’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 17 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "Id": 17, - "CollectionId": 151, - "Name": "group 1", - "Type": "Inclusive", - "PreSale": false, - "Release": false - }, - "schema": { - "type": "object", - "title": "", - "properties": { - "Id": { - "type": "integer", - "description": "SubCollection ID." - }, - "CollectionId": { - "type": "integer", - "description": "Collection ID." - }, - "Name": { - "type": "string", - "description": "SubCollection Name." - }, - "Type": { - "type": "string", - "description": "Either `“Exclusive”` (all the products contained in it will not be used) or `“Inclusive”` (all the products contained in it will be used)." - }, - "PreSale": { - "type": "boolean", - "description": "Defines if the collection is on PreSale." - }, - "Release": { - "type": "boolean", - "description": "Defines if the collection is a new released one." - } - } - } - } - } - } - } - }, - "put": { - "tags": [ - "Subcollection" - ], - "summary": "Update SubCollection", - "description": "Updates a previously SubCollection.", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "subCollectionId", - "in": "path", - "required": true, - "description": "Subcollection’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 17 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "Id": 17, - "CollectionId": 151, - "Name": "group 1", - "Type": "Inclusive", - "PreSale": false, - "Release": false - }, - "schema": { - "type": "object", - "title": "", - "properties": { - "Id": { - "type": "integer", - "description": "SubCollection ID." - }, - "CollectionId": { - "type": "integer", - "description": "Collection ID." - }, - "Name": { - "type": "string", - "description": "SubCollection Name." - }, - "Type": { - "type": "string", - "description": "Either `“Exclusive”` (all the products contained in it will not be used) or `“Inclusive”` (all the products contained in it will be used)." - }, - "PreSale": { - "type": "boolean", - "description": "Defines if the collection is on PreSale." - }, - "Release": { - "type": "boolean", - "description": "Defines if the collection is a new released one." - } - } - } - } - } - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "", - "required": [ - "CollectionId", - "Name", - "Type", - "PreSale", - "Release" - ], - "properties": { - "CollectionId": { - "type": "integer", - "title": "CollectionId", - "description": "SubCollection ID", - "default": 17 - }, - "Name": { - "type": "string", - "title": "Name", - "description": "SubCollection Name", - "default": "group 1" - }, - "Type": { - "type": "string", - "title": "Type", - "description": "Either `“Exclusive”` (all the products contained in it will not be used) or `“Inclusive”` (all the products contained in it will be used).", - "default": "Inclusive" - }, - "PreSale": { - "type": "boolean", - "title": "PreSale", - "description": "Defines PreSale date", - "default": false - }, - "Release": { - "type": "boolean", - "title": "Release", - "description": "Defines Release date", - "default": false - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "Subcollection" - ], - "summary": "Delete SubCollection", - "description": "Deletes a previously SubCollection.", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "subCollectionId", - "in": "path", - "required": true, - "description": "Subcollection’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/subcollection": { - "post": { - "tags": [ - "Subcollection" - ], - "summary": "Create SubCollection", - "description": "Creates a new SubCollection inclusion or exclusion under a Collection.", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "Id": 17, - "CollectionId": 151, - "Name": "group 1", - "Type": "Inclusive", - "PreSale": false, - "Release": false - }, - "schema": { - "type": "object", - "title": "", - "properties": { - "Id": { - "type": "integer", - "description": "SubCollection ID." - }, - "CollectionId": { - "type": "integer", - "description": "Collection ID." - }, - "Name": { - "type": "string", - "description": "SubCollection Name." - }, - "Type": { - "type": "string", - "description": "Either `“Exclusive”` (all the products contained in it will not be used) or `“Inclusive”` (all the products contained in it will be used)." - }, - "PreSale": { - "type": "boolean", - "description": "Defines if the collection is on PreSale." - }, - "Release": { - "type": "boolean", - "description": "Defines if the collection is a new released one." - } - } - } - } - } - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "", - "required": [ - "CollectionId", - "Name", - "Type", - "PreSale", - "Release" - ], - "properties": { - "CollectionId": { - "type": "integer", - "title": "CollectionId", - "description": "SubCollection ID", - "default": 17 - }, - "Name": { - "type": "string", - "title": "Name", - "description": "SubCollection Name", - "default": "group 1" - }, - "Type": { - "type": "string", - "title": "Type", - "description": "Either `“Exclusive”` (all the products contained in it will not be used) or `“Inclusive”` (all the products contained in it will be used).", - "default": "Inclusive" - }, - "PreSale": { - "type": "boolean", - "title": "PreSale", - "description": "Defines PreSale date", - "default": false - }, - "Release": { - "type": "boolean", - "title": "Release", - "description": "Defines Release date", - "default": false - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/collection/{collectionId}/position": { - "post": { - "tags": [ - "Subcollection" - ], - "summary": "Reposition SKU on the SubCollection", - "description": "Edits an SKU position that already exists in the subcollection.", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "collectionId", - "in": "path", - "required": true, - "description": "Collection’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 151 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "", - "required": [ - "skuId", - "position", - "subCollectionId" - ], - "properties": { - "skuId": { - "type": "integer", - "description": "SKU ID.", - "default": 1 - }, - "position": { - "type": "integer", - "description": "SKU position.", - "default": 1 - }, - "subCollectionId": { - "type": "integer", - "description": "Subcollection ID.", - "default": 17 - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/specification/{specificationId}": { - "get": { - "tags": [ - "Specification" - ], - "summary": "Get Specification", - "description": "Retrieves information of a Product or SKU Specification", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "specificationId", - "in": "path", - "required": true, - "description": "Specification’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "Id": 32, - "FieldTypeId": 6, - "CategoryId": 10, - "FieldGroupId": 11, - "Name": "Peso", - "Description": "Peso", - "Position": 1, - "IsFilter": false, - "IsRequired": true, - "IsOnProductDetails": false, - "IsStockKeepingUnit": true, - "IsWizard": false, - "IsActive": true, - "IsTopMenuLinkActive": false, - "IsSideMenuLinkActive": false, - "DefaultValue": null - }, - "schema": { - "type": "object", - "title": "Request body", - "required": [ - "Id", - "FieldTypeId", - "CategoryId", - "FieldGroupId", - "Name", - "Description", - "Position", - "IsFilter", - "IsRequired", - "IsOnProductDetails", - "IsStockKeepingUnit", - "IsWizard", - "IsActive", - "IsTopMenuLinkActive", - "IsSideMenuLinkActive", - "DefaultValue" - ], - "properties": { - "Id": { - "type": "integer", - "title": "Id", - "description": "Created Specification’s ID", - "default": 32 - }, - "FieldTypeId": { - "type": "integer", - "title": "FieldTypeId", - "description": "Field Type can be `1 - Text`, `2 - Multi-Line Text`, `4 - Number`, `5 - Combo`, `6 - Radio`, `7 - Checkbox`, `8 - Indexed Text`, `9 - Indexed Multi-Line Text`", - "default": 1 - }, - "CategoryId": { - "type": "integer", - "title": "CategoryId", - "description": "Specification Category ID", - "default": 0 - }, - "FieldGroupId": { - "type": "integer", - "title": "FieldGroupId", - "description": "Numerical ID of the Group of Specifications that contains the new Specification", - "default": 0 - }, - "Name": { - "type": "string", - "title": "Name", - "description": "Specification Name", - "default": "" - }, - "Description": { - "type": "string", - "title": "Description", - "description": "Specification Description", - "default": "" - }, - "Position": { - "type": "integer", - "title": "Position", - "description": "The current Specification position in comparison to the others", - "default": 0 - }, - "IsFilter": { - "type": "boolean", - "title": "IsFilter", - "description": "If the Specification can be used as a Filter", - "default": false - }, - "IsRequired": { - "type": "boolean", - "title": "IsRequired", - "description": "If the Specification is required or not", - "default": false - }, - "IsOnProductDetails": { - "type": "boolean", - "title": "IsOnProductDetails", - "description": "If the Specification will be shown on the Product screen in the specification area", - "default": false - }, - "IsStockKeepingUnit": { - "type": "boolean", - "title": "IsStockKeepingUnit", - "description": "If the Specification is applied to a specific SKU", - "default": false - }, - "IsWizard": { - "type": "boolean", - "title": "IsWizard", - "description": "Deprecated", - "default": false, - "deprecated": true - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "If the Specification is active or not ", - "default": false - }, - "IsTopMenuLinkActive": { - "type": "boolean", - "title": "IsTopMenuLinkActive", - "description": "Shows if the Specification is shown in the main menu of the site", - "default": false - }, - "IsSideMenuLinkActive": { - "type": "boolean", - "title": "IsSideMenuLinkActive", - "description": "Shows if the Specification is shown in the side menu ", - "default": false - }, - "DefaultValue": { - "type": "string", - "title": "DefaultValue", - "description": "Specification Default Value ", - "default": "", - "nullable": true - } - } - } - } - } - } - } - }, - "put": { - "tags": [ - "Specification" - ], - "summary": "Update Specification", - "description": "Updates a Product or SKU Specification", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "specificationId", - "in": "path", - "required": true, - "description": "Specification’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "required": [ - "FieldTypeId", - "CategoryId", - "FieldGroupId", - "Name", - "Description", - "Position", - "IsFilter", - "IsRequired", - "IsOnProductDetails", - "IsStockKeepingUnit", - "IsWizard", - "IsActive", - "IsTopMenuLinkActive", - "IsSideMenuLinkActive", - "DefaultValue" - ], - "properties": { - "FieldTypeId": { - "type": "integer", - "title": "FieldTypeId", - "description": "Field Type can be `1 - Text`, `2 - Multi-Line Text`, `4 - Number`, `5 - Combo`, `6 - Radio`, `7 - Checkbox`, `8 - Indexed Text`, `9 - Indexed Multi-Line Text`", - "default": 1 - }, - "CategoryId": { - "type": "integer", - "title": "CategoryId", - "description": "Specification Category ID", - "default": 0 - }, - "FieldGroupId": { - "type": "integer", - "title": "FieldGroupId", - "description": "Numerical ID of the Group of Specifications that contains the new Specification", - "default": 0 - }, - "Name": { - "type": "string", - "title": "Name", - "description": "Specification Name", - "default": "" - }, - "Description": { - "type": "string", - "title": "Description", - "description": "Specification Description", - "default": "" - }, - "Position": { - "type": "integer", - "title": "Position", - "description": "The current Specification position in comparison to the others", - "default": 0 - }, - "IsFilter": { - "type": "boolean", - "title": "IsFilter", - "description": "If the Specification can be used as a Filter", - "default": false - }, - "IsRequired": { - "type": "boolean", - "title": "IsRequired", - "description": "If the Specification is required or not", - "default": false - }, - "IsOnProductDetails": { - "type": "boolean", - "title": "IsOnProductDetails", - "description": "If the Specification will be shown on the Product screen in the specification area", - "default": false - }, - "IsStockKeepingUnit": { - "type": "boolean", - "title": "IsStockKeepingUnit", - "description": "If the Specification is applied to a specific SKU", - "default": false - }, - "IsWizard": { - "type": "boolean", - "title": "IsWizard", - "description": "Deprecated", - "default": false, - "deprecated": true - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "If the Specification is active or not ", - "default": false - }, - "IsTopMenuLinkActive": { - "type": "boolean", - "title": "IsTopMenuLinkActive", - "description": "Shows if the Specification is shown in the main menu of the site", - "default": false - }, - "IsSideMenuLinkActive": { - "type": "boolean", - "title": "IsSideMenuLinkActive", - "description": "Shows if the Specification is shown in the side menu ", - "default": false - }, - "DefaultValue": { - "type": "string", - "title": "DefaultValue", - "description": "Specification Default Value ", - "default": "" - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/specification": { - "post": { - "tags": [ - "Specification" - ], - "summary": "Create Specification", - "description": "Creates a new Product or SKU Specification", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "Id": 193, - "FieldTypeId": 1, - "CategoryId": 1, - "FieldGroupId": 22, - "Name": "Test", - "Description": null, - "Position": 1, - "IsFilter": false, - "IsRequired": false, - "IsOnProductDetails": true, - "IsStockKeepingUnit": false, - "IsWizard": false, - "IsActive": true, - "IsTopMenuLinkActive": false, - "IsSideMenuLinkActive": false, - "DefaultValue": "Test" - }, - "schema": { - "type": "object", - "title": "", - "properties": { - "Id": { - "type": "integer", - "description": "Specification ID." - }, - "FieldTypeId": { - "type": "integer", - "title": "The FieldTypeId schema", - "description": "Field Type ID can be `1 - Text`, `2 - Multi-Line Text`, `4 - Number`, `5 - Combo`, `6 - Radio`, `7 - Checkbox`, `8 - Indexed Text`, `9 - Indexed Multi-Line Text`." - }, - "CategoryId": { - "type": "integer", - "description": "Category ID associated with this specification." - }, - "FieldGroupId": { - "type": "integer", - "description": "ID of the group of specifications that contains the new specification." - }, - "Name": { - "type": "string", - "description": "Specification name." - }, - "Description": { - "type": "string", - "deprecated": true, - "nullable": true - }, - "Position": { - "type": "integer", - "description": "Store Framework - Deprecated.\r\nClassic CMS - This position number is used in ordering the specifications both in the navigation menu and in the specification listing on the product page.\r\n" - }, - "IsFilter": { - "type": "boolean", - "description": "Store Framework - Deprecated.\r\nClassic CMS - To allow the specification to be used as a facet (filter) on the search navigation bar.\r\n" - }, - "IsRequired": { - "type": "boolean", - "description": "Makes the specification mandatory (`true`) or optional (`false`)." - }, - "IsOnProductDetails": { - "type": "boolean", - "description": "Store Framework - Deprecated.\r\nClassic CMS -If specification is visible on the product page.\r\n" - }, - "IsStockKeepingUnit": { - "type": "boolean", - "description": "If `true`, it will be added as a SKU specification. If `false`, it will be added as a product specification field." - }, - "IsWizard": { - "type": "boolean", - "deprecated": true, - "nullable": true - }, - "IsActive": { - "type": "boolean", - "description": "Enable (`true`) or disable (`false`) specification." - }, - "IsTopMenuLinkActive": { - "type": "boolean", - "description": "Store Framework - Deprecated.\r\nClassic CMS - To make the specification visible in the store's upper menu.\r\n" - }, - "IsSideMenuLinkActive": { - "type": "boolean", - "description": "Store Framework - Deprecated.\r\nClassic CMS - To make the specification field clickable in the search navigation bar.\r\n" - }, - "DefaultValue": { - "type": "string", - "description": "Specification default value." - } - } - } - } - } - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "FieldTypeId", - "FieldGroupId", - "Name" - ], - "properties": { - "FieldTypeId": { - "type": "integer", - "title": "FieldTypeId", - "description": "Field Type ID can be `1 - Text`, `2 - Multi-Line Text`, `4 - Number`, `5 - Combo`, `6 - Radio`, `7 - Checkbox`, `8 - Indexed Text`, `9 - Indexed Multi-Line Text`.", - "default": 1 - }, - "CategoryId": { - "type": "integer", - "title": "CategoryId", - "description": "Category ID associated with this specification.", - "default": 1 - }, - "FieldGroupId": { - "type": "integer", - "title": "FieldGroupId", - "description": "ID of the group of specifications that contains the new specification.", - "default": 22 - }, - "Name": { - "type": "string", - "title": "Name", - "description": "Specification name.", - "default": "Test" - }, - "Description": { - "type": "string", - "deprecated": true, - "nullable": true - }, - "Position": { - "type": "integer", - "title": "Position", - "description": "Store Framework - Deprecated.\r\nClassic CMS - This position number is used in ordering the specifications both in the navigation menu and in the specification listing on the product page.\r\n", - "default": 1 - }, - "IsFilter": { - "type": "boolean", - "title": "IsFilter", - "description": "Store Framework - Deprecated.\r\nClassic CMS - To allow the specification to be used as a facet (filter) on the search navigation bar.\r\n", - "default": false - }, - "IsRequired": { - "type": "boolean", - "title": "IsRequired", - "description": "Makes the specification mandatory (`true`) or optional (`false`).", - "default": false - }, - "IsOnProductDetails": { - "type": "boolean", - "title": "IsOnProductDetails", - "description": "Store Framework - Deprecated.\r\nClassic CMS -If specification is visible on the product page.\r\n", - "default": true - }, - "IsStockKeepingUnit": { - "type": "boolean", - "title": "IsStockKeepingUnit", - "description": "If `true`, it will be added as a SKU specification. If `false`, it will be added as a product specification field.", - "default": false - }, - "IsWizard": { - "type": "boolean", - "deprecated": true, - "nullable": true - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "Enable (`true`) or disable (`false`) specification.", - "default": true - }, - "IsTopMenuLinkActive": { - "type": "boolean", - "title": "IsTopMenuLinkActive", - "description": "Store Framework - Deprecated.\r\nClassic CMS - To make the specification visible in the store's upper menu.\r\n", - "default": false - }, - "IsSideMenuLinkActive": { - "type": "boolean", - "title": "IsSideMenuLinkActive", - "description": "Store Framework - Deprecated.\r\nClassic CMS - To make the specification field clickable in the search navigation bar.\r\n", - "default": false - }, - "DefaultValue": { - "type": "string", - "title": "DefaultValue", - "description": "Specification default value.", - "default": "Test" - } - } - } - } - } - } - } - }, - "/api/catalog_system/pub/specification/fieldGet/{fieldId}": { - "get": { - "tags": [ - "Specification Field" - ], - "summary": "Get Specifications Field", - "description": "Retrieves details from a specification field by this field's ID.", - "operationId": "SpecificationsField", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "fieldId", - "in": "path", - "description": "Specification Field ID", - "required": true, - "style": "simple", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {} - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pvt/specification/field": { - "post": { - "tags": [ - "Specification Field" - ], - "summary": "Create Specifications Field", - "description": "Creates a specification field in a category.", - "operationId": "SpecificationsInsertField", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SpecificationsInsertFieldRequest" - }, - "example": { - "Name": "FieldNameExample", - "CategoryId": null, - "IsActive": true, - "IsRequired": false, - "FieldTypeId": 5, - "FieldValueId": 1, - "Description": null, - "IsStockKeepingUnit": false, - "IsFilter": true, - "IsOnProductDetails": true, - "Position": 1, - "IsTopMenuLinkActive": true, - "IsSideMenuLinkActive": true, - "DefaultValue": null, - "FieldGroupId": 5 - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": {} - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Specification Field" - ], - "summary": "Update Specifications Field", - "description": "Updates a specification field in a category.", - "operationId": "SpecificationsInsertFieldUpdate", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SpecificationsInsertFieldUpdateRequest" - }, - "example": { - "FieldId": 89, - "Name": "FieldNameExample2", - "CategoryId": null, - "IsActive": true, - "IsRequired": false, - "FieldTypeId": 5, - "IsFilter": true, - "FieldGroupId": 5 - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "headers": {} - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pvt/specification/fieldValue/{fieldValueId}": { - "get": { - "tags": [ - "Specification Field Value" - ], - "summary": "Get Specifications Field Value", - "description": "Retrieves details from a specification field's value by this value's ID.", - "operationId": "SpecificationsGetFieldValue", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "fieldValueId", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "headers": {} - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pub/specification/fieldvalue/{fieldId}": { - "get": { - "tags": [ - "Specification Field Value" - ], - "summary": "Get Specifications Values By Field Id", - "description": "Gets a list of all specification values from a Specification Field by this field's ID.", - "operationId": "SpecificationsValuesByFieldId", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "fieldId", - "in": "path", - "description": "Specification Field ID", - "required": true, - "style": "simple", - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": { - "Cache-Control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Content-Length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "564" - } - } - }, - "Date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Tue, 27 Jun 2017 00:30:34 GMT" - } - } - }, - "Expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-1" - } - } - }, - "Pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Microsoft-IIS/10.0" - } - } - }, - "X-Accel-Expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "120" - } - } - }, - "X-AspNet-Version": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "4.0.30319" - } - } - }, - "X-Powered-By": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "ASP.NET" - } - } - }, - "no": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "CELOCOUTO" - } - } - }, - "p3p": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "policyref=\"/w3c/p3p.xml\",CP=\"ADMa OUR NOR CNT NID DSP NOI COR\"" - } - } - }, - "powered": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "vtex" - } - } - }, - "x-vtex-operation-id": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "26972701-3cdb-46cb-be29-13ea2b1b83d0" - } - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Example10" - } - }, - "example": [ - { - "FieldValueId": 52, - "Value": "0 a 6 meses", - "IsActive": true, - "Position": 1 - }, - { - "FieldValueId": 53, - "Value": "1 a 2 anos", - "IsActive": true, - "Position": 4 - }, - { - "FieldValueId": 54, - "Value": "3 a 4 anos", - "IsActive": true, - "Position": 3 - }, - { - "FieldValueId": 55, - "Value": "5 a 6 anos", - "IsActive": true, - "Position": 2 - }, - { - "FieldValueId": 56, - "Value": "7 a 8 anos", - "IsActive": true, - "Position": 5 - }, - { - "FieldValueId": 57, - "Value": "9 a 10 anos", - "IsActive": true, - "Position": 6 - }, - { - "FieldValueId": 58, - "Value": "Acima de 10 anos", - "IsActive": true, - "Position": 7 - }, - { - "FieldValueId": 114, - "Value": "AAAA", - "IsActive": true, - "Position": 8 - } - ] - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pvt/specification/fieldValue": { - "post": { - "tags": [ - "Specification Field Value" - ], - "summary": "Create Specifications Field Value", - "description": "Creates a specification field value by the specification field's ID.", - "operationId": "SpecificationsInsertFieldValue", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SpecificationsInsertFieldValueRequest" - }, - "example": { - "FieldId": 34, - "Name": "TesteInsert", - "Text": "Value Description", - "IsActive": true, - "Position": 100 - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": {} - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Specification Field Value" - ], - "summary": "Update Specifications Field Value", - "description": "Updates a specification field value by the specification field's ID.", - "operationId": "SpecificationsUpdateFieldValue", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SpecificationsUpdateFieldValueRequest" - }, - "example": { - "FieldValueId": 276, - "Name": "TesteInsertUpdate", - "Text": "Value Description2", - "IsActive": true, - "Position": 100 - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": {} - } - }, - "deprecated": false - } - }, - "/api/catalog/pvt/specificationvalue/{specificationValueId}": { - "get": { - "tags": [ - "Specification Value" - ], - "summary": "Get Specification Value", - "description": "Retrieves general information about a Specification Value ", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "specificationValueId", - "in": "path", - "required": true, - "description": " Specification Value’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - }, - "put": { - "tags": [ - "Specification Value" - ], - "summary": "Update Specification Value", - "description": "Updates a new Specification Value for a Category", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "specificationValueId", - "in": "path", - "required": true, - "description": " Specification Value’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "example": { - "FieldId": 101, - "Name": "Test", - "Text": null, - "IsActive": true, - "Position": 1 - }, - "required": [ - "FieldId", - "Name", - "Text", - "IsActive", - "Position" - ], - "properties": { - "FieldId": { - "type": "integer", - "title": "FieldId", - "description": "Field ID", - "default": 1 - }, - "Name": { - "type": "string", - "title": "Name", - "description": "Specification Value Name", - "default": "" - }, - "Text": { - "type": "string", - "title": "Text", - "description": "Specification Value Text", - "default": "", - "nullable": true - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "Shows if the Category is active or not", - "default": true - }, - "Position": { - "type": "integer", - "title": "Position", - "description": "The current Specification Value’s position in comparison to the others", - "default": 1 - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/specificationvalue": { - "post": { - "tags": [ - "Specification Value" - ], - "summary": "Create Specification Value", - "description": "Creates a new Specification Value for a Category", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "FieldValueId": 360, - "FieldId": 193, - "Name": "Metal", - "Text": null, - "IsActive": true, - "Position": 1 - }, - "schema": { - "type": "object", - "title": "", - "properties": { - "FieldValueId": { - "type": "integer", - "description": "Specification value ID." - }, - "FieldId": { - "type": "integer", - "description": "Specification ID associated with this specification value." - }, - "Name": { - "type": "string", - "description": "Specification Value name." - }, - "Text": { - "type": "string", - "deprecated": true, - "nullable": true - }, - "IsActive": { - "type": "boolean", - "description": "Enable (`true`) or disable (`false`) specification value." - }, - "Position": { - "type": "integer", - "description": "The position of the value to be shown on product registration page (`/admin/Site/Produto.aspx`)." - } - } - } - } - } - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "FieldId", - "Name" - ], - "properties": { - "FieldId": { - "type": "integer", - "title": "FieldId", - "description": "Specification ID associated with this specification value.", - "default": 193 - }, - "Name": { - "type": "string", - "title": "Name", - "description": "Specification Value name.", - "default": "Metal" - }, - "Text": { - "type": "string", - "deprecated": true, - "nullable": true - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "Enable (`true`) or disable (`false`) specification value.", - "default": true - }, - "Position": { - "type": "integer", - "title": "Position", - "description": "The position of the value to be shown on product registration page (`/admin/Site/Produto.aspx`).", - "default": 1 - } - } - } - } - } - } - } - }, - "/api/catalog_system/pvt/specification/groupbycategory/{categoryId}": { - "get": { - "tags": [ - "Specification Group" - ], - "summary": " List Specifications Group by Category", - "description": "Retrieves a list of specification groups by the category ID.", - "operationId": "SpecificationsGroupListbyCategory", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "categoryId", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": { - "Cache-Control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Content-Length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "799" - } - } - }, - "Date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Fri, 04 Aug 2017 00:08:38 GMT" - } - } - }, - "Expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-1" - } - } - }, - "Pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Microsoft-IIS/10.0" - } - } - }, - "X-AspNet-Version": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "4.0.30319" - } - } - }, - "X-Powered-By": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "ASP.NET" - } - } - }, - "no": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "CELOCOUTO" - } - } - }, - "p3p": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "policyref=\"/w3c/p3p.xml\",CP=\"ADMa OUR NOR CNT NID DSP NOI COR\"" - } - } - }, - "powered": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "vtex" - } - } - }, - "x-vtex-operation-id": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "17c7a31d-6267-4714-95b9-0978f55ff2cc" - } - } - } - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/example12" - } - }, - "example": [ - { - "CategoryId": null, - "Id": 4, - "Name": "Filtros", - "Position": 1 - }, - { - "CategoryId": null, - "Id": 5, - "Name": "Primeiro Grupo", - "Position": 2 - }, - { - "CategoryId": null, - "Id": 6, - "Name": "Segundo Grupo", - "Position": 3 - }, - { - "CategoryId": null, - "Id": 18, - "Name": "Insertedfromapi3", - "Position": null - }, - { - "CategoryId": null, - "Id": 19, - "Name": "Insertedfromapi4", - "Position": 10 - }, - { - "CategoryId": null, - "Id": 20, - "Name": "Insertedfromapi5", - "Position": null - }, - { - "CategoryId": null, - "Id": 21, - "Name": "Insertedfromapi6", - "Position": null - }, - { - "CategoryId": null, - "Id": 22, - "Name": "Insertedfromapi7", - "Position": null - }, - { - "CategoryId": null, - "Id": 24, - "Name": "Insertedfromapi9", - "Position": 1 - }, - { - "CategoryId": null, - "Id": 25, - "Name": "Insertedfromapi10", - "Position": null - }, - { - "CategoryId": null, - "Id": 26, - "Name": "Insertedfromapi26", - "Position": 1 - }, - { - "CategoryId": null, - "Id": 27, - "Name": "GroupName", - "Position": 1 - } - ] - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pub/specification/groupGet/{groupId}": { - "get": { - "tags": [ - "Specification Group" - ], - "summary": "Get Specifications Group", - "description": "Retrieves details from a specification group by the ID of this group.", - "operationId": "SpecificationsGroupGet", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "groupId", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": { - "Cache-Control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Connection": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "keep-alive" - } - } - }, - "Content-Length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "63" - } - } - }, - "Date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Fri, 21 Jul 2017 18:36:14 GMT" - } - } - }, - "Expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-1" - } - } - }, - "Pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "nginx" - } - } - }, - "X-CacheServer": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "janus-apicache-nginx17" - } - } - }, - "X-Powered-by-VTEX-Janus-ApiCache": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "v1.3.9" - } - } - }, - "X-Powered-by-VTEX-Janus-Edge": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "v1.36.4" - } - } - }, - "X-Track": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "stable" - } - } - }, - "X-VTEX-Cache-Status-Janus-ApiCache": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "MISS" - } - } - }, - "X-VTEX-Cache-Status-Janus-Edge": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "MISS" - } - } - }, - "X-VTEX-Janus-Router-Backend-App": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "prtapi-v1.4.769-stable+566" - } - } - }, - "no": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-LU4RKGF3FDT" - } - } - }, - "p3p": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "policyref=\"/w3c/p3p.xml\",CP=\"ADMa OUR NOR CNT NID DSP NOI COR\"" - } - } - }, - "powered": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "vtex" - } - } - }, - "x-vtex-operation-id": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "5858766c-08ee-4760-8ddd-49b6cc9d4d9e" - } - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/example11" - }, - "example": { - "CategoryId": null, - "Id": 5, - "Name": "Primeiro Grupo", - "Position": 2 - } - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog/pvt/specificationgroup": { - "post": { - "tags": [ - "Specification Group" - ], - "summary": "Create Specification Group", - "description": "Create a specification group.", - "operationId": "SpecificationGroupInsert2", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SpecificationGroupInsertRequest" - }, - "example": { - "CategoryId": 1, - "Name": "GroupName1" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "title": "", - "type": "object", - "properties": { - "Id": { - "type": "integer", - "format": "int32", - "description": "Specification Group ID." - }, - "CategoryId": { - "type": "integer", - "format": "int32", - "description": "Category ID." - }, - "Name": { - "type": "string", - "description": "Specification Group Name." - }, - "Position": { - "type": "integer", - "format": "int32", - "description": "Store Framework - Deprecated.\r\nClassic CMS - Specification Group Position." - } - } - }, - "example": { - "Id": 10, - "CategoryId": 10, - "Name": "GroupName", - "Position": 3 - } - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pvt/specification/group": { - "post": { - "tags": [ - "Specification Group" - ], - "summary": "Create Specification Group", - "description": "Create a specification group.", - "operationId": "SpecificationGroupInsert", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SpecificationGroupInsertRequest" - }, - "example": { - "CategoryId": 1, - "Name": "GroupName1" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": { - "Cache-Control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Content-Length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "56" - } - } - }, - "Date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Fri, 21 Jul 2017 19:49:39 GMT" - } - } - }, - "Expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-1" - } - } - }, - "Pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Microsoft-IIS/10.0" - } - } - }, - "X-AspNet-Version": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "4.0.30319" - } - } - }, - "X-Powered-By": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "ASP.NET" - } - } - }, - "no": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "CELOCOUTO" - } - } - }, - "p3p": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "policyref=\"/w3c/p3p.xml\",CP=\"ADMa OUR NOR CNT NID DSP NOI COR\"" - } - } - }, - "powered": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "vtex" - } - } - }, - "x-vtex-operation-id": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "88496f04-3b62-42a9-96e3-2c7243241690" - } - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/example13" - }, - "example": { - "CategoryId": 1, - "Id": 28, - "Name": "GroupName", - "Position": 3 - } - } - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Specification Group" - ], - "summary": "Update Specification Group", - "description": "Update a specification group", - "operationId": "SpecificationGroupUpdate", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SpecificationGroupUpdateRequest" - }, - "example": { - "Id": 31, - "Name": "NewGroupName" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": {} - } - }, - "deprecated": false - } - }, - "/api/catalog/pvt/specificationgroup/{groupId}": { - "put": { - "tags": [ - "Specification Group" - ], - "summary": "Update Specification Group", - "description": "Update a specification group", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "groupId", - "in": "path", - "required": true, - "description": "Group’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "required": [ - "CategoryId", - "Name", - "Position" - ], - "properties": { - "CategoryId": { - "type": "integer", - "title": "CategoryId", - "description": "Category ID where the Specification Group is contained", - "default": 1 - }, - "Name": { - "type": "string", - "title": "Name", - "description": "Specification Group Name", - "default": "" - }, - "Position": { - "type": "integer", - "title": "Position", - "description": "Specification Group Position", - "default": 1 - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/specification/nonstructured/{Id}": { - "get": { - "tags": [ - "Non Structured Specification" - ], - "summary": "Get Specification Non Structured", - "description": "Gets general information about unmapped Specifications of a Seller SKU in a Marketplace", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Id", - "in": "path", - "required": true, - "description": "Non Structured Specification’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - }, - "delete": { - "tags": [ - "Non Structured Specification" - ], - "summary": "Delete Specification Non Structured", - "description": "Deletes unmapped Specifications of a Seller SKU in a Marketplace by its unique ID", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Id", - "in": "path", - "required": true, - "description": "Non Structured Specification’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/specification/nonstructured": { - "get": { - "tags": [ - "Non Structured Specification" - ], - "summary": "Get Specification Non Structured by SkuId", - "description": "Gets general information about unmapped Specifications of a Seller SKU in a Marketplace by its unique ID", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "query", - "required": true, - "description": "SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - }, - "delete": { - "tags": [ - "Non Structured Specification" - ], - "summary": "Delete Specification Non Structured by SkuId", - "description": "Deletes unmapped Specifications of a Seller SKU in a Marketplace by its unique ID", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "skuId", - "in": "query", - "required": true, - "description": "SKU’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog_system/pvt/saleschannel/list": { - "get": { - "tags": [ - "Sales Channel" - ], - "summary": "Get Sales Channel List", - "description": "Retrieves a list with details about the store's sales channels.", - "operationId": "SalesChannelList", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {} - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pub/saleschannel/{salesChannelId}": { - "get": { - "tags": [ - "Sales Channel" - ], - "summary": "Get Sales Channel by Id", - "description": "Retrieves a specific sales channel by its ID.", - "operationId": "SalesChannelbyId", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "salesChannelId", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {} - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pvt/seller/list": { - "get": { - "tags": [ - "Seller" - ], - "summary": "Get Seller List", - "description": "Retrieves the seller's details by its ID.", - "operationId": "SellerList", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "sc", - "in": "query", - "description": "Trade policy ID.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 1 - } - }, - { - "name": "sellerType", - "in": "query", - "description": "Seller type.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "integer", - "format": "int32", - "default": 1 - } - }, - { - "name": "isBetterScope", - "in": "query", - "description": "If the seller is better scope.", - "required": false, - "style": "form", - "explode": true, - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "example": { - "SellerId": "pedrostore", - "Name": "pedrostore", - "Email": "breno@breno.com", - "Description": "", - "ExchangeReturnPolicy": "", - "DeliveryPolicy": "", - "UseHybridPaymentOptions": false, - "UserName": null, - "Password": null, - "SecutityPrivacyPolicy": "", - "CNPJ": "12035072751", - "CSCIdentification": "pedrostore", - "ArchiveId": null, - "UrlLogo": null, - "ProductCommissionPercentage": 0.0, - "FreightCommissionPercentage": 0.0, - "CategoryCommissionPercentage": "[{\"CategoryId\":14,\"ProductCommission\":15.0,\"FreightCommission\":0.0}]", - "FulfillmentEndpoint": "http://pedrostore.vtexcommercestable.com.br/api/fulfillment?affiliateid=LDB&sc=1", - "CatalogSystemEndpoint": "http://pedrostore.vtexcommercestable.com.br/api/catalog_system/", - "IsActive": true, - "MerchantName": "", - "FulfillmentSellerId": null, - "SellerType": 1, - "IsBetterScope": false, - "TrustPolicy": "Default" - }, - "type": "object", - "title": "", - "properties": { - "SellerId": { - "type": "string", - "description": "Code used to identify the seller. It is assigned by the marketplace. We recommend filling it in with the seller's account name." - }, - "Name": { - "type": "string", - "description": "Name of the account in the seller's environment. You can find it on **Account settings > Account > Account Name**). Applicable only if the seller uses their own payment method." - }, - "Email": { - "type": "string", - "description": "Email of the admin responsible for the seller. " - }, - "Description": { - "type": "string", - "description": "Text describing the seller with a marketing tone. You can display this text in the marketplace window display by [customizing the CMS](https://help.vtex.com/en/tutorial/list-of-controls-for-templates--tutorials_563)." - }, - "ExchangeReturnPolicy": { - "type": "string", - "description": "Text describing the exchange and return policy previously agreed between the marketplace and the seller." - }, - "DeliveryPolicy": { - "type": "string", - "description": "Text describing the delivery policy previously agreed between the marketplace and the seller." - }, - "UseHybridPaymentOptions": { - "type": "boolean", - "description": "Allows customers to use gift cards from the seller to buy their products on the marketplace. It identifies purchases made with a gift card so that only the final price (with discounts applied) is paid to the seller. " - }, - "UserName": { - "type": "string", - "description": "Seller username.", - "nullable": true - }, - "Password": { - "type": "string", - "description": "Seller password.", - "nullable": true - }, - "SecutityPrivacyPolicy": { - "type": "string", - "description": "Text describing the security policy previously agreed between the marketplace and the seller." - }, - "CNPJ": { - "type": "string", - "description": "Company registration number." - }, - "CSCIdentification": { - "type": "string", - "description": "CSC identification." - }, - "ArchiveId": { - "type": "integer", - "description": "Seller archive ID.", - "nullable": true - }, - "UrlLogo": { - "type": "string", - "description": "Seller URL logo." - }, - "ProductCommissionPercentage": { - "type": "number", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`." - }, - "FreightCommissionPercentage": { - "type": "number", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`." - }, - "CategoryCommissionPercentage": { - "type": "number", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`." - }, - "FulfillmentEndpoint": { - "type": "string", - "description": "URL of the endpoint for fulfillment of seller's orders, which the marketplace will use to communicate with the seller. This field applies to all sellers, regardless of their type. However, for `VTEX Stores`, you don’t need to fill it in because the system will do that automatically. You can edit this field once the seller has been successfully added.", - "nullable": true - }, - "CatalogSystemEndpoint": { - "type": "string", - "description": "URL of the endpoint of the seller's catalog. This field will only be displayed if the seller type is VTEX Store. The field format will be as follows: `http://{sellerName}.vtexcommercestable.com.br/api/catalog_system/`." - }, - "IsActive": { - "type": "boolean", - "description": "If the selle is active (`true`) or not (`false`)." - }, - "MerchantName": { - "type": "string", - "description": "Name of the marketplace, used to guide payments. This field should be nulled if the marketplace is responsible for processing payments. Check out our [Split Payment](https://help.vtex.com/en/tutorial/split-de-pagamento--6k5JidhYRUxileNolY2VLx) article to know more." - }, - "FulfillmentSellerId": { - "type": "integer", - "description": "Identification code of the seller responsible for fulfilling the order. This is an optional field used when a seller sells SKUs from another seller. If the seller sells their own SKUs, it must be left blank.", - "nullable": true - }, - "SellerType": { - "type": "integer", - "description": "Seller type." - }, - "IsBetterScope": { - "type": "boolean", - "description": "Indicates whether it is a [comprehensive seller](https://help.vtex.com/en/tutorial/comprehensive-seller--5Qn4O2GpjUIzWTPpvLUfkI)." - }, - "TrustPolicy": { - "type": "string", - "description": "Seller trust policy. The default value is `'Default'`, but if your store is a B2B marketplace and you want to share the customers'emails with the sellers you need to set this field as `'AllowEmailSharing'`." - } - } - } - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pvt/seller/{sellerId}": { - "get": { - "tags": [ - "Seller" - ], - "summary": "Get Seller by ID", - "description": "Retrieves the seller's details by its ID.", - "operationId": "GetSellerbyId", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "sellerId", - "in": "path", - "description": "ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "pedrostore" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "example": { - "SellerId": "pedrostore", - "Name": "pedrostore", - "Email": "breno@breno.com", - "Description": "", - "ExchangeReturnPolicy": "", - "DeliveryPolicy": "", - "UseHybridPaymentOptions": false, - "UserName": null, - "Password": null, - "SecutityPrivacyPolicy": "", - "CNPJ": "12035072751", - "CSCIdentification": "pedrostore", - "ArchiveId": null, - "UrlLogo": "", - "ProductCommissionPercentage": 0.0, - "FreightCommissionPercentage": 0.0, - "CategoryCommissionPercentage": "[{\"CategoryId\":14,\"ProductCommission\":15.0,\"FreightCommission\":0.0}]", - "FulfillmentEndpoint": "http://pedrostore.vtexcommercestable.com.br/api/fulfillment?affiliateid=LDB&sc=1", - "CatalogSystemEndpoint": "http://pedrostore.vtexcommercestable.com.br/api/catalog_system/", - "IsActive": true, - "MerchantName": "", - "FulfillmentSellerId": null, - "SellerType": 1, - "IsBetterScope": false, - "TrustPolicy": "Default" - }, - "type": "object", - "title": "", - "description": "Object with information of all sellers in the store.", - "properties": { - "SellerId": { - "type": "string", - "description": "Code used to identify the seller. It is assigned by the marketplace. We recommend filling it in with the seller's account name." - }, - "Name": { - "type": "string", - "description": "Name of the account in the seller's environment. You can find it on **Account settings > Account > Account Name**). Applicable only if the seller uses their own payment method." - }, - "Email": { - "type": "string", - "description": "Email of the admin responsible for the seller. " - }, - "Description": { - "type": "string", - "description": "Text describing the seller with a marketing tone. You can display this text in the marketplace window display by [customizing the CMS](https://help.vtex.com/en/tutorial/list-of-controls-for-templates--tutorials_563)." - }, - "ExchangeReturnPolicy": { - "type": "string", - "description": "Text describing the exchange and return policy previously agreed between the marketplace and the seller." - }, - "DeliveryPolicy": { - "type": "string", - "description": "Text describing the delivery policy previously agreed between the marketplace and the seller." - }, - "UseHybridPaymentOptions": { - "type": "boolean", - "description": "Allows customers to use gift cards from the seller to buy their products on the marketplace. It identifies purchases made with a gift card so that only the final price (with discounts applied) is paid to the seller. " - }, - "UserName": { - "type": "string", - "description": "Seller username.", - "nullable": true - }, - "Password": { - "type": "string", - "description": "Seller password.", - "nullable": true - }, - "SecutityPrivacyPolicy": { - "type": "string", - "description": "Text describing the security policy previously agreed between the marketplace and the seller." - }, - "CNPJ": { - "type": "string", - "description": "Company registration number." - }, - "CSCIdentification": { - "type": "string", - "description": "CSC identification." - }, - "ArchiveId": { - "type": "integer", - "description": "Seller archive ID.", - "nullable": true - }, - "UrlLogo": { - "type": "string", - "description": "Seller URL logo." - }, - "ProductCommissionPercentage": { - "type": "number", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`." - }, - "FreightCommissionPercentage": { - "type": "number", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`." - }, - "CategoryCommissionPercentage": { - "type": "number", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`." - }, - "FulfillmentEndpoint": { - "type": "string", - "description": "URL of the endpoint for fulfillment of seller's orders, which the marketplace will use to communicate with the seller. This field applies to all sellers, regardless of their type. However, for `VTEX Stores`, you don’t need to fill it in because the system will do that automatically. You can edit this field once the seller has been successfully added.", - "nullable": true - }, - "CatalogSystemEndpoint": { - "type": "string", - "description": "URL of the endpoint of the seller's catalog. This field will only be displayed if the seller type is VTEX Store. The field format will be as follows: `http://{sellerName}.vtexcommercestable.com.br/api/catalog_system/`." - }, - "IsActive": { - "type": "boolean", - "description": "If the selle is active (`true`) or not (`false`)." - }, - "MerchantName": { - "type": "string", - "description": "Name of the marketplace, used to guide payments. This field should be nulled if the marketplace is responsible for processing payments. Check out our [Split Payment](https://help.vtex.com/en/tutorial/split-de-pagamento--6k5JidhYRUxileNolY2VLx) article to know more." - }, - "FulfillmentSellerId": { - "type": "integer", - "description": "Identification code of the seller responsible for fulfilling the order. This is an optional field used when a seller sells SKUs from another seller. If the seller sells their own SKUs, it must be left blank.", - "nullable": true - }, - "SellerType": { - "type": "integer", - "description": "Seller type." - }, - "IsBetterScope": { - "type": "boolean", - "description": "Indicates whether it is a [comprehensive seller](https://help.vtex.com/en/tutorial/comprehensive-seller--5Qn4O2GpjUIzWTPpvLUfkI)." - }, - "TrustPolicy": { - "type": "string", - "description": "Seller trust policy. The default value is `'Default'`, but if your store is a B2B marketplace and you want to share the customers'emails with the sellers you need to set this field as `'AllowEmailSharing'`." - } - } - } - } - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Seller" - ], - "summary": "Update Seller", - "description": "Updates a seller.", - "operationId": "UpdateSeller", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "sellerId", - "in": "path", - "description": "ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "pedrostore" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateSellerRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "example": { - "SellerId": "pedrostore", - "Name": "pedrostore", - "Email": "breno@breno.com", - "Description": "", - "ExchangeReturnPolicy": "", - "DeliveryPolicy": "", - "UseHybridPaymentOptions": false, - "UserName": null, - "Password": null, - "SecutityPrivacyPolicy": "", - "CNPJ": "12035072751", - "CSCIdentification": "pedrostore", - "ArchiveId": null, - "UrlLogo": null, - "ProductCommissionPercentage": 0.0, - "FreightCommissionPercentage": 0.0, - "CategoryCommissionPercentage": "[{\"CategoryId\":14,\"ProductCommission\":15.0,\"FreightCommission\":0.0}]", - "FulfillmentEndpoint": "http://pedrostore.vtexcommercestable.com.br/api/fulfillment?affiliateid=LDB&sc=1", - "CatalogSystemEndpoint": "http://pedrostore.vtexcommercestable.com.br/api/catalog_system/", - "IsActive": true, - "MerchantName": "", - "FulfillmentSellerId": null, - "SellerType": 1, - "IsBetterScope": false, - "TrustPolicy": "Default" - }, - "type": "object", - "title": "", - "properties": { - "SellerId": { - "type": "string", - "description": "Code used to identify the seller. It is assigned by the marketplace. We recommend filling it in with the seller's account name." - }, - "Name": { - "type": "string", - "description": "Name of the account in the seller's environment. You can find it on **Account settings > Account > Account Name**). Applicable only if the seller uses their own payment method." - }, - "Email": { - "type": "string", - "description": "Email of the admin responsible for the seller. " - }, - "Description": { - "type": "string", - "description": "Text describing the seller with a marketing tone. You can display this text in the marketplace window display by [customizing the CMS](https://help.vtex.com/en/tutorial/list-of-controls-for-templates--tutorials_563)." - }, - "ExchangeReturnPolicy": { - "type": "string", - "description": "Text describing the exchange and return policy previously agreed between the marketplace and the seller." - }, - "DeliveryPolicy": { - "type": "string", - "description": "Text describing the delivery policy previously agreed between the marketplace and the seller." - }, - "UseHybridPaymentOptions": { - "type": "boolean", - "description": "Allows customers to use gift cards from the seller to buy their products on the marketplace. It identifies purchases made with a gift card so that only the final price (with discounts applied) is paid to the seller. " - }, - "UserName": { - "type": "string", - "description": "Seller username.", - "nullable": true - }, - "Password": { - "type": "string", - "description": "Seller password.", - "nullable": true - }, - "SecutityPrivacyPolicy": { - "type": "string", - "description": "Text describing the security policy previously agreed between the marketplace and the seller." - }, - "CNPJ": { - "type": "string", - "description": "Company registration number." - }, - "CSCIdentification": { - "type": "string", - "description": "CSC identification." - }, - "ArchiveId": { - "type": "integer", - "description": "Seller archive ID.", - "nullable": true - }, - "UrlLogo": { - "type": "string", - "description": "Seller URL logo." - }, - "ProductCommissionPercentage": { - "type": "number", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`." - }, - "FreightCommissionPercentage": { - "type": "number", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`." - }, - "CategoryCommissionPercentage": { - "type": "number", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`." - }, - "FulfillmentEndpoint": { - "type": "string", - "description": "URL of the endpoint for fulfillment of seller's orders, which the marketplace will use to communicate with the seller. This field applies to all sellers, regardless of their type. However, for `VTEX Stores`, you don’t need to fill it in because the system will do that automatically. You can edit this field once the seller has been successfully added.", - "nullable": true - }, - "CatalogSystemEndpoint": { - "type": "string", - "description": "URL of the endpoint of the seller's catalog. This field will only be displayed if the seller type is VTEX Store. The field format will be as follows: `http://{sellerName}.vtexcommercestable.com.br/api/catalog_system/`." - }, - "IsActive": { - "type": "boolean", - "description": "If the selle is active (`true`) or not (`false`)." - }, - "MerchantName": { - "type": "string", - "description": "Name of the marketplace, used to guide payments. This field should be nulled if the marketplace is responsible for processing payments. Check out our [Split Payment](https://help.vtex.com/en/tutorial/split-de-pagamento--6k5JidhYRUxileNolY2VLx) article to know more." - }, - "FulfillmentSellerId": { - "type": "integer", - "description": "Identification code of the seller responsible for fulfilling the order. This is an optional field used when a seller sells SKUs from another seller. If the seller sells their own SKUs, it must be left blank.", - "nullable": true - }, - "SellerType": { - "type": "integer", - "description": "Seller type." - }, - "IsBetterScope": { - "type": "boolean", - "description": "Indicates whether it is a [comprehensive seller](https://help.vtex.com/en/tutorial/comprehensive-seller--5Qn4O2GpjUIzWTPpvLUfkI)." - }, - "TrustPolicy": { - "type": "string", - "description": "Seller trust policy. The default value is `'Default'`, but if your store is a B2B marketplace and you want to share the customers'emails with the sellers you need to set this field as `'AllowEmailSharing'`." - } - } - } - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pvt/seller": { - "post": { - "tags": [ - "Seller" - ], - "summary": "Create Seller", - "description": "Creates a new seller.", - "operationId": "CreateSeller", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateSellerRequest" - }, - "example": { - "SellerId": "myseller", - "Name": "My Seller", - "Email": "myseller@vtex.com", - "Description": "", - "ExchangeReturnPolicy": "", - "DeliveryPolicy": "", - "UseHybridPaymentOptions": false, - "UserName": "", - "Password": "", - "SecutityPrivacyPolicy": "", - "CNPJ": "12345678912345", - "CSCIdentification": "myseller", - "ArchiveId": null, - "UrlLogo": "", - "ProductCommissionPercentage": 1.5, - "FreightCommissionPercentage": 0, - "FulfillmentEndpoint": "http://fulfillment.vtexcommerce.com.br/api/fulfillment?affiliateid=VTX&sc=1&an=myseller", - "CatalogSystemEndpoint": "http://myseller.vtexcommercestable.com.br/api/catalog_system/", - "IsActive": true, - "FulfillmentSellerId": "", - "SellerType": 1, - "IsBetterScope": false - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "example": { - "SellerId": "pedrostore", - "Name": "pedrostore", - "Email": "breno@breno.com", - "Description": "", - "ExchangeReturnPolicy": "", - "DeliveryPolicy": "", - "UseHybridPaymentOptions": false, - "UserName": null, - "Password": null, - "SecutityPrivacyPolicy": "", - "CNPJ": "12035072751", - "CSCIdentification": "pedrostore", - "ArchiveId": null, - "UrlLogo": null, - "ProductCommissionPercentage": 0.0, - "FreightCommissionPercentage": 0.0, - "CategoryCommissionPercentage": "[{\"CategoryId\":14,\"ProductCommission\":15.0,\"FreightCommission\":0.0}]", - "FulfillmentEndpoint": "http://pedrostore.vtexcommercestable.com.br/api/fulfillment?affiliateid=LDB&sc=1", - "CatalogSystemEndpoint": "http://pedrostore.vtexcommercestable.com.br/api/catalog_system/", - "IsActive": true, - "MerchantName": "", - "FulfillmentSellerId": null, - "SellerType": 1, - "IsBetterScope": false, - "TrustPolicy": "Default" - }, - "type": "object", - "title": "", - "properties": { - "SellerId": { - "type": "string", - "description": "Code used to identify the seller. It is assigned by the marketplace. We recommend filling it in with the seller's account name." - }, - "Name": { - "type": "string", - "description": "Name of the account in the seller's environment. You can find it on **Account settings > Account > Account Name**). Applicable only if the seller uses their own payment method." - }, - "Email": { - "type": "string", - "description": "Email of the admin responsible for the seller. " - }, - "Description": { - "type": "string", - "description": "Text describing the seller with a marketing tone. You can display this text in the marketplace window display by [customizing the CMS](https://help.vtex.com/en/tutorial/list-of-controls-for-templates--tutorials_563)." - }, - "ExchangeReturnPolicy": { - "type": "string", - "description": "Text describing the exchange and return policy previously agreed between the marketplace and the seller." - }, - "DeliveryPolicy": { - "type": "string", - "description": "Text describing the delivery policy previously agreed between the marketplace and the seller." - }, - "UseHybridPaymentOptions": { - "type": "boolean", - "description": "Allows customers to use gift cards from the seller to buy their products on the marketplace. It identifies purchases made with a gift card so that only the final price (with discounts applied) is paid to the seller. " - }, - "UserName": { - "type": "string", - "description": "Seller username.", - "nullable": true - }, - "Password": { - "type": "string", - "description": "Seller password.", - "nullable": true - }, - "SecutityPrivacyPolicy": { - "type": "string", - "description": "Text describing the security policy previously agreed between the marketplace and the seller." - }, - "CNPJ": { - "type": "string", - "description": "Company registration number." - }, - "CSCIdentification": { - "type": "string", - "description": "CSC identification." - }, - "ArchiveId": { - "type": "integer", - "description": "Seller archive ID.", - "nullable": true - }, - "UrlLogo": { - "type": "string", - "description": "Seller URL logo." - }, - "ProductCommissionPercentage": { - "type": "number", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`." - }, - "FreightCommissionPercentage": { - "type": "number", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`." - }, - "CategoryCommissionPercentage": { - "type": "number", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`." - }, - "FulfillmentEndpoint": { - "type": "string", - "description": "URL of the endpoint for fulfillment of seller's orders, which the marketplace will use to communicate with the seller. This field applies to all sellers, regardless of their type. However, for `VTEX Stores`, you don’t need to fill it in because the system will do that automatically. You can edit this field once the seller has been successfully added.", - "nullable": true - }, - "CatalogSystemEndpoint": { - "type": "string", - "description": "URL of the endpoint of the seller's catalog. This field will only be displayed if the seller type is VTEX Store. The field format will be as follows: `http://{sellerName}.vtexcommercestable.com.br/api/catalog_system/`." - }, - "IsActive": { - "type": "boolean", - "description": "If the selle is active (`true`) or not (`false`)." - }, - "MerchantName": { - "type": "string", - "description": "Name of the marketplace, used to guide payments. This field should be nulled if the marketplace is responsible for processing payments. Check out our [Split Payment](https://help.vtex.com/en/tutorial/split-de-pagamento--6k5JidhYRUxileNolY2VLx) article to know more." - }, - "FulfillmentSellerId": { - "type": "integer", - "description": "Identification code of the seller responsible for fulfilling the order. This is an optional field used when a seller sells SKUs from another seller. If the seller sells their own SKUs, it must be left blank.", - "nullable": true - }, - "SellerType": { - "type": "integer", - "description": "Seller type." - }, - "IsBetterScope": { - "type": "boolean", - "description": "Indicates whether it is a [comprehensive seller](https://help.vtex.com/en/tutorial/comprehensive-seller--5Qn4O2GpjUIzWTPpvLUfkI)." - }, - "TrustPolicy": { - "type": "string", - "description": "Seller trust policy. The default value is `'Default'`, but if your store is a B2B marketplace and you want to share the customers'emails with the sellers you need to set this field as `'AllowEmailSharing'`." - } - } - } - } - } - } - } - } - }, - "/api/catalog_system/pvt/sellers/{sellerId}": { - "get": { - "tags": [ - "Seller" - ], - "summary": "Get Seller by ID", - "description": "Retrieves the seller's details by its ID.", - "operationId": "GetSellersbyId", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "sellerId", - "in": "path", - "description": "ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "pedrostore" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "example": { - "SellerId": "pedrostore", - "Name": "pedrostore", - "Email": "breno@breno.com", - "Description": "", - "ExchangeReturnPolicy": "", - "DeliveryPolicy": "", - "UseHybridPaymentOptions": false, - "UserName": null, - "Password": null, - "SecutityPrivacyPolicy": "", - "CNPJ": "12035072751", - "CSCIdentification": "pedrostore", - "ArchiveId": null, - "UrlLogo": "", - "ProductCommissionPercentage": 0.0, - "FreightCommissionPercentage": 0.0, - "CategoryCommissionPercentage": "[{\"CategoryId\":14,\"ProductCommission\":15.0,\"FreightCommission\":0.0}]", - "FulfillmentEndpoint": "http://pedrostore.vtexcommercestable.com.br/api/fulfillment?affiliateid=LDB&sc=1", - "CatalogSystemEndpoint": "http://pedrostore.vtexcommercestable.com.br/api/catalog_system/", - "IsActive": true, - "MerchantName": "", - "FulfillmentSellerId": null, - "SellerType": 1, - "IsBetterScope": false, - "TrustPolicy": "Default" - }, - "type": "object", - "title": "", - "description": "Object with information of all sellers in the store.", - "properties": { - "SellerId": { - "type": "string", - "description": "Code used to identify the seller. It is assigned by the marketplace. We recommend filling it in with the seller's account name." - }, - "Name": { - "type": "string", - "description": "Name of the account in the seller's environment. You can find it on **Account settings > Account > Account Name**). Applicable only if the seller uses their own payment method.", - "nullable": true - }, - "Email": { - "type": "string", - "description": "Email of the admin responsible for the seller. ", - "nullable": true - }, - "Description": { - "type": "string", - "description": "Text describing the seller with a marketing tone. You can display this text in the marketplace window display by [customizing the CMS](https://help.vtex.com/en/tutorial/list-of-controls-for-templates--tutorials_563)." - }, - "ExchangeReturnPolicy": { - "type": "string", - "description": "Text describing the exchange and return policy previously agreed between the marketplace and the seller." - }, - "DeliveryPolicy": { - "type": "string", - "description": "Text describing the delivery policy previously agreed between the marketplace and the seller." - }, - "UseHybridPaymentOptions": { - "type": "boolean", - "description": "Allows customers to use gift cards from the seller to buy their products on the marketplace. It identifies purchases made with a gift card so that only the final price (with discounts applied) is paid to the seller. " - }, - "UserName": { - "type": "string", - "description": "Seller username.", - "nullable": true - }, - "Password": { - "type": "string", - "description": "Seller password.", - "nullable": true - }, - "SecutityPrivacyPolicy": { - "type": "string", - "description": "Text describing the security policy previously agreed between the marketplace and the seller." - }, - "CNPJ": { - "type": "string", - "description": "Company registration number." - }, - "CSCIdentification": { - "type": "string", - "description": "CSC identification." - }, - "ArchiveId": { - "type": "integer", - "description": "Seller archive ID.", - "nullable": true - }, - "UrlLogo": { - "type": "string", - "description": "Seller URL logo." - }, - "ProductCommissionPercentage": { - "type": "number", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`." - }, - "FreightCommissionPercentage": { - "type": "number", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`." - }, - "CategoryCommissionPercentage": { - "type": "number", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`." - }, - "FulfillmentEndpoint": { - "type": "string", - "description": "URL of the endpoint for fulfillment of seller's orders, which the marketplace will use to communicate with the seller. This field applies to all sellers, regardless of their type. However, for `VTEX Stores`, you don’t need to fill it in because the system will do that automatically. You can edit this field once the seller has been successfully added.", - "nullable": true - }, - "CatalogSystemEndpoint": { - "type": "string", - "description": "URL of the endpoint of the seller's catalog. This field will only be displayed if the seller type is VTEX Store. The field format will be as follows: `http://{sellerName}.vtexcommercestable.com.br/api/catalog_system/`." - }, - "IsActive": { - "type": "boolean", - "description": "If the selle is active (`true`) or not (`false`)." - }, - "MerchantName": { - "type": "string", - "description": "Name of the marketplace, used to guide payments. This field should be nulled if the marketplace is responsible for processing payments. Check out our [Split Payment](https://help.vtex.com/en/tutorial/split-de-pagamento--6k5JidhYRUxileNolY2VLx) article to know more." - }, - "FulfillmentSellerId": { - "type": "integer", - "description": "Identification code of the seller responsible for fulfilling the order. This is an optional field used when a seller sells SKUs from another seller. If the seller sells their own SKUs, it must be left blank.", - "nullable": true - }, - "SellerType": { - "type": "integer", - "description": "Seller type." - }, - "IsBetterScope": { - "type": "boolean", - "description": "Indicates whether it is a [comprehensive seller](https://help.vtex.com/en/tutorial/comprehensive-seller--5Qn4O2GpjUIzWTPpvLUfkI)." - }, - "TrustPolicy": { - "type": "string", - "description": "Seller trust policy. The default value is `'Default'`, but if your store is a B2B marketplace and you want to share the customers'emails with the sellers you need to set this field as `'AllowEmailSharing'`." - } - } - } - } - } - } - }, - "deprecated": false - } - }, - "/api/catalog/pvt/supplier": { - "post": { - "tags": [ - "Supplier" - ], - "summary": "Create Supplier", - "description": "Creates a new Supplier from scratch", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "required": [ - "Name", - "CorporateName", - "StateInscription", - "Cnpj", - "Phone", - "CellPhone", - "CorportePhone", - "Email", - "IsActive" - ], - "properties": { - "Name": { - "type": "string", - "title": "Name", - "description": "Supplier Name", - "default": "" - }, - "CorporateName": { - "type": "string", - "title": "CorporateName", - "description": "Supplier Corporate Name", - "default": "" - }, - "StateInscription": { - "type": "string", - "title": "StateInscription", - "description": "State Inscription", - "default": "" - }, - "Cnpj": { - "type": "string", - "title": "Cnpj", - "description": "Business ID", - "default": "" - }, - "Phone": { - "type": "string", - "title": "Phone", - "description": "Supplier Phone", - "default": "" - }, - "CellPhone": { - "type": "string", - "title": "CellPhone", - "description": "Supplier Cellphone", - "default": "" - }, - "CorportePhone": { - "type": "string", - "title": "CorportePhone", - "description": "Supplier Corporate Phone", - "default": "" - }, - "Email": { - "type": "string", - "title": "Email", - "description": "Supplier e-mail", - "default": "" - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "If Supplier is active or not", - "default": false - } - } - } - } - } - } - } - }, - "/api/catalog/pvt/supplier/{supplierId}": { - "put": { - "tags": [ - "Supplier" - ], - "summary": "Update Supplier", - "description": "Updates general information of an existing Supplier", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "supplierId", - "in": "path", - "required": true, - "description": "Category’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "Request body", - "required": [ - "Name", - "CorporateName", - "StateInscription", - "Cnpj", - "Phone", - "CellPhone", - "CorportePhone", - "Email", - "IsActive" - ], - "properties": { - "Name": { - "type": "string", - "title": "Name", - "description": "Supplier Name", - "default": "" - }, - "CorporateName": { - "type": "string", - "title": "CorporateName", - "description": "Supplier Corporate Name", - "default": "" - }, - "StateInscription": { - "type": "string", - "title": "StateInscription", - "description": "State Inscription", - "default": "" - }, - "Cnpj": { - "type": "string", - "title": "Cnpj", - "description": "Business ID", - "default": "" - }, - "Phone": { - "type": "string", - "title": "Phone", - "description": "Supplier Phone", - "default": "" - }, - "CellPhone": { - "type": "string", - "title": "CellPhone", - "description": "Supplier Cellphone", - "default": "" - }, - "CorportePhone": { - "type": "string", - "title": "CorportePhone", - "description": "Supplier Corporate Phone", - "default": "" - }, - "Email": { - "type": "string", - "title": "Email", - "description": "Supplier e-mail", - "default": "" - }, - "IsActive": { - "type": "boolean", - "title": "IsActive", - "description": "If Supplier is active or not", - "default": false - } - } - } - } - } - } - }, - "delete": { - "tags": [ - "Supplier" - ], - "summary": "Delete Supplier", - "description": "Deletes an existing Supplier", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "supplierId", - "in": "path", - "required": true, - "description": "Category’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/product/{productId}/salespolicy": { - "get": { - "tags": [ - "Trade Policy" - ], - "summary": "Get Trade Policy by Product ID", - "description": "Retrieves a Trade Policy associated to a Product by its ID", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "required": true, - "description": "Product’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog/pvt/product/{productId}/salespolicy/{tradepolicyId}": { - "post": { - "tags": [ - "Trade Policy" - ], - "summary": "Create Product to Trade Policy", - "description": "Associates a existing Trade Policy with a Product", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "required": true, - "description": "Product’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "tradepolicyId", - "in": "path", - "required": true, - "description": "Trade Policy’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - }, - "delete": { - "tags": [ - "Trade Policy" - ], - "summary": "Delete Product to Trade Policy", - "description": "Disassociates a Trade Policy to a Product", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "required": true, - "description": "Product’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "tradepolicyId", - "in": "path", - "required": true, - "description": "Trade Policy’s unique numerical identifier", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/api/catalog_system/pvt/sku/stockkeepingunitidsbysaleschannel": { - "get": { - "tags": [ - "Trade Policy" - ], - "summary": "List all SKUs of a Trade Policy", - "description": "Retrieves a list of SKU IDs of one Trade Policy", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "sc", - "in": "query", - "required": true, - "description": "Trade Policy’s unique numerical identifier", - "style": "form", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "page", - "in": "query", - "required": false, - "description": "Page number", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "pageSize", - "in": "query", - "required": false, - "description": "Number of the items of the page", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "onlyAssigned", - "in": "query", - "required": false, - "description": "If set as `false`, it allows user to decide if the SKUs that are not assigned to a specific trade policy should be also returned", - "schema": { - "type": "boolean", - "default": true - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": [ - 1, - 2, - 3, - 4, - 5, - 6, - 7, - 8, - 9, - 10, - 11, - 12, - 13, - 14, - 15, - 16, - 17, - 18, - 19, - 20, - 21, - 22, - 23, - 24, - 25, - 26, - 27, - 28, - 405023, - 405024, - 405025, - 405026, - 405027, - 405028, - 405029, - 405030, - 405031, - 405032, - 405033, - 405034, - 405035, - 405036, - 405037, - 405038, - 405039, - 405040, - 405041, - 405042, - 405367, - 405368, - 405369, - 405370, - 405371, - 405372, - 405373, - 405374, - 405375, - 405376, - 405377, - 405378, - 405379, - 405380, - 405381, - 405382, - 405383, - 405384, - 405385, - 405386, - 405387, - 405388, - 405389, - 405390, - 405391, - 405392, - 405393, - 405394, - 405395, - 405396, - 405397, - 405398, - 405399, - 405400, - 405556 - ], - "schema": { - "type": "array", - "title": "data", - "description": "List of SKU IDs of the Trade Policy", - "items": { - "type": "integer", - "default": 1 - } - } - } - } - } - } - } - }, - "/api/catalog_system/pvt/products/GetIndexedInfo/{productId}": { - "get": { - "tags": [ - "Product Indexed" - ], - "summary": "Get Indexed Info", - "description": "Retrieve details of Product Indexed Info", - "operationId": "IndexedInfo", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "productId", - "in": "path", - "description": "Product’s unique numerical identifier", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {} - } - }, - "deprecated": false - } - }, - "/api/catalog_system/pvt/commercialcondition/list": { - "get": { - "tags": [ - "Commercial Conditions" - ], - "summary": "Get all commercial conditions", - "description": "Lists all commercial conditions on the store.", - "operationId": "GetAllCommercialConditions", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "title": "Array with information of all the commercial conditions.", - "example": [ - { - "Id": 1, - "Name": "Padrão", - "IsDefault": true - }, - { - "Id": 2, - "Name": "Secundária", - "IsDefault": false - }, - { - "Id": 3, - "Name": "Parcelamento 18x", - "IsDefault": false - } - ], - "items": { - "type": "object", - "title": "", - "description": "Object with information of the commercial condition.", - "example": { - "Id": 1, - "Name": "Padrão", - "IsDefault": true - }, - "properties": { - "Id": { - "type": "integer", - "title": "Id", - "description": "Commercial condition ID.", - "example": 1 - }, - "Name": { - "type": "string", - "title": "Name", - "description": "Commercial condition name.", - "example": "Padrão" - }, - "IsDefault": { - "type": "boolean", - "title": "IsDefault", - "description": "If the commercial condition is default (`true`) or not (`false`).", - "example": true - } - } - } - } - } - } - } - } - } - }, - "/api/catalog_system/pvt/commercialcondition/{commercialConditionId}": { - "get": { - "tags": [ - "Commercial Conditions" - ], - "summary": "Get a commercial condition", - "description": "Retrives information of a commercial condition.", - "operationId": "GetCommercialConditions", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Describes the type of the content being sent", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "commercialConditionId", - "in": "path", - "required": true, - "description": "Commercial condition unique numerical identifier", - "schema": { - "type": "integer", - "example": 1 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "", - "description": "Object with information of the commercial condition.", - "example": { - "Id": 1, - "Name": "Padrão", - "IsDefault": true - }, - "properties": { - "Id": { - "type": "integer", - "title": "Id", - "description": "Commercial condition ID.", - "example": 1 - }, - "Name": { - "type": "string", - "title": "Name", - "description": "Commercial condition name.", - "example": "Padrão" - }, - "IsDefault": { - "type": "boolean", - "title": "IsDefault", - "description": "If the commercial condition is default (`true`) or not (`false`).", - "example": true - } - } - } - } - } - } - } - } - } - }, - "security": [ - { - "appKey": [], - "appToken": [] - } - ], - "components": { - "securitySchemes": { - "appKey": { - "type": "apiKey", - "in": "header", - "name": "X-VTEX-API-AppKey" - }, - "appToken": { - "type": "apiKey", - "in": "header", - "name": "X-VTEX-API-AppToken" - } - }, - "schemas": { - "SKUFileURL": { - "type": "object", - "required": [ - "Name", - "Url" - ], - "properties": { - "IsMain": { - "type": "boolean", - "title": "IsMain", - "description": "Set the image as the main image for the product.", - "example": true - }, - "Label": { - "type": "string", - "title": "Label", - "description": "SKU image label.", - "example": "Main" - }, - "Name": { - "type": "string", - "title": "Name", - "description": "SKU image name.", - "example": "Nike-Red-Janoski-1" - }, - "Text": { - "type": "string", - "title": "Text", - "description": "General text of the image.", - "example": "Nike-Red-Janoski" - }, - "Url": { - "type": "string", - "title": "Url", - "description": "External Image's URL.", - "example": "https://m.media-amazon.com/images/I/610G2-sJx5L._AC_UX695_.jpg" - } - } - }, - "SKUFile": { - "type": "string", - "format": "binary", - "description": "The image file has a size limit of 3200 x 3200 pixels." - }, - "Example": { - "title": "Example", - "required": [ - "parentId", - "id", - "name", - "hasChildren", - "url", - "children" - ], - "type": "object", - "properties": { - "parentId": { - "type": "string", - "nullable": true - }, - "id": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string" - }, - "hasChildren": { - "type": "boolean" - }, - "url": { - "type": "string", - "nullable": true - }, - "children": { - "type": "string", - "nullable": true - } - }, - "example": { - "parentId": null, - "id": 77, - "name": "Games", - "hasChildren": true, - "url": null, - "children": null - } - }, - "Example1": { - "title": "Example1", - "required": [ - "id", - "name", - "hasChildren", - "url", - "children" - ], - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32", - "description": "Category ID." - }, - "name": { - "type": "string", - "description": "Category name." - }, - "hasChildren": { - "type": "boolean", - "description": "If the category has a category child (`true`) or not (`false`)." - }, - "url": { - "type": "string", - "description": "Category URL" - }, - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Child" - }, - "description": "Object with information about the category's children" - } - }, - "example": { - "id": 77, - "name": "Games", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/games", - "children": [ - { - "id": 78, - "name": "Xbox 360", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/games/xbox-360", - "children": [ - { - "id": 79, - "name": "Consoles", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/games/xbox-360/consoles", - "children": [] - }, - { - "id": 126, - "name": "Acessorio", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/games/xbox-360/acessorio", - "children": [] - } - ] - }, - { - "id": 132, - "name": "PS4", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/games/ps4", - "children": [] - } - ] - } - }, - "Child": { - "title": "Child", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32", - "description": "Child category ID." - }, - "name": { - "type": "string", - "description": "Child category name." - }, - "hasChildren": { - "type": "boolean", - "description": "If the child category has a category child (`true`) or not (`false`)." - }, - "url": { - "type": "string", - "description": "Child category URL" - }, - "children": { - "type": "array", - "description": "Object with information about the category's children" - } - }, - "example": { - "id": 78, - "name": "Xbox 360", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/games/xbox-360", - "children": [ - { - "id": 79, - "name": "Consoles", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/games/xbox-360/consoles", - "children": [] - }, - { - "id": 126, - "name": "Acessorio", - "hasChildren": false, - "url": "https://ambienteqa.vtexcommercestable.com.br/games/xbox-360/acessorio", - "children": [] - } - ] - } - }, - "Brand": { - "title": "Brand", - "required": [ - "id", - "name", - "isActive", - "title", - "metaTagDescription" - ], - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32", - "description": "ID of the brand." - }, - "name": { - "type": "string", - "description": "Name of the brand." - }, - "isActive": { - "type": "boolean", - "description": "If the brand is active (`true`) or not (`false`)." - }, - "title": { - "type": "string", - "description": "Tag title for the brand page." - }, - "metaTagDescription": { - "type": "string", - "description": "Meta description for the brand page." - }, - "imageUrl": { - "type": "string", - "description": "URL of the brand's image.", - "nullable": true - } - }, - "example": { - "id": 7000000, - "name": "Test Brand", - "isActive": true, - "title": "Test Brand", - "metaTagDescription": "Test Brand" - } - }, - "Example2": { - "title": "Example2", - "required": [ - "Value", - "Id", - "Name" - ], - "type": "object", - "properties": { - "Value": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - }, - "Id": { - "type": "integer", - "format": "int32" - }, - "Name": { - "type": "string" - } - }, - "example": { - "Value": [ - "Iron", - "Plastic" - ], - "Id": 30, - "Name": "Material" - } - }, - "UpdateProductSpecificationRequest": { - "title": "Request Body", - "required": [ - "Value" - ], - "type": "object", - "properties": { - "Value": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Values of the Specification" - }, - "Id": { - "type": "integer", - "format": "int32", - "description": "ID of the Specification" - }, - "Name": { - "type": "string", - "description": "Name of the Specification" - } - }, - "example": { - "Value": [ - "Rubber", - "Plastic" - ], - "Id": 30 - } - }, - "Example3": { - "title": "Example3", - "required": [ - "Id", - "Name", - "DepartmentId", - "CategoryId", - "BrandId", - "LinkId", - "RefId", - "IsVisible", - "Description", - "DescriptionShort", - "ReleaseDate", - "KeyWords", - "Title", - "IsActive", - "TaxCode", - "MetaTagDescription", - "SupplierId", - "ShowWithoutStock", - "ListStoreId", - "AdWordsRemarketingCode", - "LomadeeCampaignCode" - ], - "type": "object", - "properties": { - "Id": { - "type": "integer", - "format": "int32" - }, - "Name": { - "type": "string" - }, - "DepartmentId": { - "type": "integer", - "format": "int32" - }, - "CategoryId": { - "type": "integer", - "format": "int32" - }, - "BrandId": { - "type": "integer", - "format": "int32" - }, - "LinkId": { - "type": "string" - }, - "RefId": { - "type": "string" - }, - "IsVisible": { - "type": "boolean" - }, - "Description": { - "type": "string" - }, - "DescriptionShort": { - "type": "string" - }, - "ReleaseDate": { - "type": "string" - }, - "KeyWords": { - "type": "string" - }, - "Title": { - "type": "string" - }, - "IsActive": { - "type": "boolean" - }, - "TaxCode": { - "type": "string" - }, - "MetaTagDescription": { - "type": "string" - }, - "SupplierId": { - "type": "integer", - "format": "int32" - }, - "ShowWithoutStock": { - "type": "boolean" - }, - "ListStoreId": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "" - }, - "AdWordsRemarketingCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - }, - "LomadeeCampaignCode": { - "type": "string", - "description": "This is a legacy field. Do not take this information into consideration." - } - }, - "example": { - "Id": 2001426, - "Name": "Tabela de Basquete", - "DepartmentId": 59, - "CategoryId": 59, - "BrandId": 2000018, - "LinkId": "Tabela-de-Basquete", - "RefId": "", - "IsVisible": true, - "Description": "Tabela de Basquete", - "DescriptionShort": "", - "ReleaseDate": "2014-04-30T00:00:00", - "KeyWords": "Basquete, NBA, Tabela, NBB", - "Title": "Tabela de Basquete", - "IsActive": true, - "TaxCode": "", - "MetaTagDescription": "Tabela de Basquete", - "SupplierId": 1, - "ShowWithoutStock": false, - "ListStoreId": [ - 1, - 2, - 3, - 10 - ], - "AdWordsRemarketingCode": "", - "LomadeeCampaignCode": "" - } - }, - "Example4": { - "title": "Example4", - "required": [ - "Id", - "ProductId", - "NameComplete", - "ProductName", - "ProductDescription", - "SkuName", - "IsActive", - "IsTransported", - "IsInventoried", - "IsGiftCardRecharge", - "ImageUrl", - "DetailUrl", - "CSCIdentification", - "BrandId", - "BrandName", - "Dimension", - "RealDimension", - "ManufacturerCode", - "IsKit", - "KitItems", - "Services", - "Categories", - "Attachments", - "Collections", - "SkuSellers", - "SalesChannels", - "Images", - "SkuSpecifications", - "ProductSpecifications", - "ProductClustersIds", - "ProductCategoryIds", - "ProductGlobalCategoryId", - "ProductCategories", - "CommercialConditionId", - "RewardValue", - "AlternateIds", - "AlternateIdValues", - "EstimatedDateArrival", - "MeasurementUnit", - "UnitMultiplier", - "InformationSource", - "ModalType" - ], - "type": "object", - "properties": { - "Id": { - "type": "integer", - "format": "int32" - }, - "ProductId": { - "type": "integer", - "format": "int32" - }, - "NameComplete": { - "type": "string" - }, - "ProductName": { - "type": "string" - }, - "ProductDescription": { - "type": "string" - }, - "SkuName": { - "type": "string" - }, - "IsActive": { - "type": "boolean" - }, - "IsTransported": { - "type": "boolean" - }, - "IsInventoried": { - "type": "boolean" - }, - "IsGiftCardRecharge": { - "type": "boolean" - }, - "ImageUrl": { - "type": "string" - }, - "DetailUrl": { - "type": "string" - }, - "CSCIdentification": { - "type": "string", - "nullable": true - }, - "BrandId": { - "type": "string" - }, - "BrandName": { - "type": "string" - }, - "Dimension": { - "$ref": "#/components/schemas/Dimension" - }, - "RealDimension": { - "$ref": "#/components/schemas/RealDimension" - }, - "ManufacturerCode": { - "type": "string" - }, - "IsKit": { - "type": "boolean" - }, - "KitItems": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - }, - "Services": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - }, - "Categories": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - }, - "Attachments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Attachment" - }, - "description": "" - }, - "Collections": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - }, - "SkuSellers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SkuSeller" - }, - "description": "" - }, - "SalesChannels": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "" - }, - "Images": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Image" - }, - "description": "" - }, - "SkuSpecifications": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SkuSpecification" - }, - "description": "" - }, - "ProductSpecifications": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSpecification" - }, - "description": "" - }, - "ProductClustersIds": { - "type": "string" - }, - "ProductCategoryIds": { - "type": "string" - }, - "ProductGlobalCategoryId": { - "type": "string", - "nullable": true - }, - "ProductCategories": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "CommercialConditionId": { - "type": "integer", - "format": "int32" - }, - "RewardValue": { - "type": "number" - }, - "AlternateIds": { - "$ref": "#/components/schemas/AlternateIds" - }, - "AlternateIdValues": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - }, - "EstimatedDateArrival": { - "type": "string", - "nullable": true - }, - "MeasurementUnit": { - "type": "string" - }, - "UnitMultiplier": { - "type": "number" - }, - "InformationSource": { - "type": "string" - }, - "ModalType": { - "type": "string", - "nullable": true - } - }, - "example": { - "Id": 2001773, - "ProductId": 2001426, - "NameComplete": "Tabela de Basquete", - "ProductName": "Tabela de Basquete", - "ProductDescription": "Tabela de Basquete", - "SkuName": "Tabela de Basquete", - "IsActive": true, - "IsTransported": true, - "IsInventoried": true, - "IsGiftCardRecharge": false, - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168952-55-55/7508800GG.jpg", - "DetailUrl": "/tabela-de-basquete/p", - "CSCIdentification": null, - "BrandId": "2000018", - "BrandName": "MARCA ARGOLO TESTE", - "Dimension": { - "cubicweight": 81.6833, - "height": 65, - "length": 58, - "weight": 10000, - "width": 130 - }, - "RealDimension": { - "realCubicWeight": 274.1375, - "realHeight": 241, - "realLength": 65, - "realWeight": 9800, - "realWidth": 105 - }, - "ManufacturerCode": "", - "IsKit": false, - "KitItems": [], - "Services": [], - "Categories": [], - "Attachments": [ - { - "Id": 3, - "Name": "Mensagem", - "Keys": [ - "nome;20", - "foto;40" - ], - "Fields": [ - { - "FieldName": "nome", - "MaxCaracters": "20", - "DomainValues": "Adalberto,Pedro,João" - }, - { - "FieldName": "foto", - "MaxCaracters": "40", - "DomainValues": null - } - ], - "IsActive": true, - "IsRequired": false - } - ], - "Collections": [], - "SkuSellers": [ - { - "SellerId": "1", - "StockKeepingUnitId": 2001773, - "SellerStockKeepingUnitId": "2001773", - "IsActive": true, - "FreightCommissionPercentage": 0, - "ProductCommissionPercentage": 0 - } - ], - "SalesChannels": [ - 1, - 2, - 3, - 10 - ], - "Images": [ - { - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168952/7508800GG.jpg", - "ImageName": "", - "FileId": 168952 - }, - { - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168953/7508800_1GG.jpg", - "ImageName": "", - "FileId": 168953 - }, - { - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168954/7508800_2GG.jpg", - "ImageName": "", - "FileId": 168954 - } - ], - "SkuSpecifications": [ - { - "FieldId": 102, - "FieldName": "Cor", - "FieldValueIds": [ - 266 - ], - "FieldValues": [ - "Padrão" - ] - } - ], - "ProductSpecifications": [ - { - "FieldId": 7, - "FieldName": "Faixa Etária", - "FieldValueIds": [ - 58, - 56, - 55, - 52 - ], - "FieldValues": [ - "5 a 6 anos", - "7 a 8 anos", - "9 a 10 anos", - "Acima de 10 anos" - ] - }, - { - "FieldId": 23, - "FieldName": "Fabricante", - "FieldValueIds": [], - "FieldValues": [ - "Xalingo" - ] - } - ], - "ProductClustersIds": "176,187,192,194,211,217,235,242", - "ProductCategoryIds": "/59/", - "ProductGlobalCategoryId": null, - "ProductCategories": { - "59": "Brinquedos" - }, - "CommercialConditionId": 1, - "RewardValue": 100.0, - "AlternateIds": { - "Ean": "8781", - "RefId": "878181" - }, - "AlternateIdValues": [ - "8781", - "878181" - ], - "EstimatedDateArrival": "", - "MeasurementUnit": "un", - "UnitMultiplier": 1, - "InformationSource": "Indexer", - "ModalType": "" - } - }, - "Dimension": { - "title": "Dimension", - "required": [ - "cubicweight", - "height", - "length", - "weight", - "width" - ], - "type": "object", - "properties": { - "cubicweight": { - "type": "number" - }, - "height": { - "type": "number" - }, - "length": { - "type": "number" - }, - "weight": { - "type": "number" - }, - "width": { - "type": "number" - } - }, - "example": { - "cubicweight": 81.6833, - "height": 65, - "length": 58, - "weight": 10000, - "width": 130 - } - }, - "RealDimension": { - "title": "RealDimension", - "required": [ - "realCubicWeight", - "realHeight", - "realLength", - "realWeight", - "realWidth" - ], - "type": "object", - "properties": { - "realCubicWeight": { - "type": "number" - }, - "realHeight": { - "type": "number" - }, - "realLength": { - "type": "number" - }, - "realWeight": { - "type": "number" - }, - "realWidth": { - "type": "number" - } - }, - "example": { - "realCubicWeight": 274.1375, - "realHeight": 241, - "realLength": 65, - "realWeight": 9800, - "realWidth": 105 - } - }, - "Attachment": { - "title": "Attachment", - "required": [ - "Id", - "Name", - "Keys", - "Fields", - "IsActive", - "IsRequired" - ], - "type": "object", - "properties": { - "Id": { - "type": "integer", - "format": "int32" - }, - "Name": { - "type": "string" - }, - "Keys": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - }, - "Fields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Field" - }, - "description": "" - }, - "IsActive": { - "type": "boolean" - }, - "IsRequired": { - "type": "boolean" - } - }, - "example": { - "Id": 3, - "Name": "Mensagem", - "Keys": [ - "nome;20", - "foto;40" - ], - "Fields": [ - { - "FieldName": "nome", - "MaxCaracters": "20", - "DomainValues": "Adalberto,Pedro,João" - }, - { - "FieldName": "foto", - "MaxCaracters": "40", - "DomainValues": null - } - ], - "IsActive": true, - "IsRequired": false - } - }, - "Field": { - "title": "Field", - "required": [ - "FieldName", - "MaxCaracters", - "DomainValues" - ], - "type": "object", - "properties": { - "FieldName": { - "type": "string" - }, - "MaxCaracters": { - "type": "string" - }, - "DomainValues": { - "type": "string", - "nullable": true - } - }, - "example": { - "FieldName": "nome", - "MaxCaracters": "20", - "DomainValues": "Adalberto,Pedro,João" - } - }, - "SkuSeller": { - "title": "SkuSeller", - "required": [ - "SellerId", - "StockKeepingUnitId", - "SellerStockKeepingUnitId", - "IsActive", - "FreightCommissionPercentage", - "ProductCommissionPercentage" - ], - "type": "object", - "properties": { - "SellerId": { - "type": "string", - "description": "ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID." - }, - "StockKeepingUnitId": { - "type": "integer", - "format": "int32" - }, - "SellerStockKeepingUnitId": { - "type": "string" - }, - "IsActive": { - "type": "boolean" - }, - "FreightCommissionPercentage": { - "type": "number" - }, - "ProductCommissionPercentage": { - "type": "number" - } - }, - "example": { - "SellerId": "1", - "StockKeepingUnitId": 2001773, - "SellerStockKeepingUnitId": "2001773", - "IsActive": true, - "FreightCommissionPercentage": 0, - "ProductCommissionPercentage": 0 - } - }, - "Image": { - "title": "Image", - "required": [ - "ImageUrl", - "ImageName", - "FileId" - ], - "type": "object", - "properties": { - "ImageUrl": { - "type": "string" - }, - "ImageName": { - "type": "string" - }, - "FileId": { - "type": "integer", - "format": "int32" - } - }, - "example": { - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168952/7508800GG.jpg", - "ImageName": "", - "FileId": 168952 - } - }, - "SkuSpecification": { - "title": "SkuSpecification", - "required": [ - "FieldId", - "FieldName", - "FieldValueIds", - "FieldValues" - ], - "type": "object", - "properties": { - "FieldId": { - "type": "integer", - "format": "int32" - }, - "FieldName": { - "type": "string" - }, - "FieldValueIds": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "" - }, - "FieldValues": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - } - }, - "example": { - "FieldId": 102, - "FieldName": "Cor", - "FieldValueIds": [ - 266 - ], - "FieldValues": [ - "Padrão" - ] - } - }, - "ProductSpecification": { - "title": "ProductSpecification", - "required": [ - "FieldId", - "FieldName", - "FieldValueIds", - "FieldValues" - ], - "type": "object", - "properties": { - "FieldId": { - "type": "integer", - "format": "int32" - }, - "FieldName": { - "type": "string" - }, - "FieldValueIds": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "" - }, - "FieldValues": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - } - }, - "example": { - "FieldId": 7, - "FieldName": "Faixa Etária", - "FieldValueIds": [ - 58, - 56, - 55, - 52 - ], - "FieldValues": [ - "5 a 6 anos", - "7 a 8 anos", - "9 a 10 anos", - "Acima de 10 anos" - ] - } - }, - "AlternateIds": { - "title": "AlternateIds", - "required": [ - "Ean", - "RefId" - ], - "type": "object", - "properties": { - "Ean": { - "type": "string" - }, - "RefId": { - "type": "string" - } - }, - "example": { - "Ean": "8781", - "RefId": "878181" - } - }, - "Example5": { - "title": "Example5", - "required": [ - "Id", - "ProductId", - "NameComplete", - "ProductName", - "ProductDescription", - "SkuName", - "IsActive", - "IsTransported", - "IsInventoried", - "IsGiftCardRecharge", - "ImageUrl", - "DetailUrl", - "CSCIdentification", - "BrandId", - "BrandName", - "Dimension", - "RealDimension", - "ManufacturerCode", - "IsKit", - "KitItems", - "Services", - "Categories", - "Attachments", - "Collections", - "SkuSellers", - "SalesChannels", - "Images", - "SkuSpecifications", - "ProductSpecifications", - "ProductClustersIds", - "ProductCategoryIds", - "ProductGlobalCategoryId", - "ProductCategories", - "CommercialConditionId", - "RewardValue", - "AlternateIds", - "AlternateIdValues", - "EstimatedDateArrival", - "MeasurementUnit", - "UnitMultiplier", - "InformationSource", - "ModalType" - ], - "type": "object", - "properties": { - "Id": { - "type": "integer", - "format": "int32" - }, - "ProductId": { - "type": "integer", - "format": "int32" - }, - "NameComplete": { - "type": "string" - }, - "ProductName": { - "type": "string" - }, - "ProductDescription": { - "type": "string" - }, - "SkuName": { - "type": "string" - }, - "IsActive": { - "type": "boolean" - }, - "IsTransported": { - "type": "boolean" - }, - "IsInventoried": { - "type": "boolean" - }, - "IsGiftCardRecharge": { - "type": "boolean" - }, - "ImageUrl": { - "type": "string" - }, - "DetailUrl": { - "type": "string" - }, - "CSCIdentification": { - "type": "string", - "nullable": true - }, - "BrandId": { - "type": "string" - }, - "BrandName": { - "type": "string" - }, - "Dimension": { - "$ref": "#/components/schemas/Dimension" - }, - "RealDimension": { - "$ref": "#/components/schemas/RealDimension" - }, - "ManufacturerCode": { - "type": "string" - }, - "IsKit": { - "type": "boolean" - }, - "KitItems": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - }, - "Services": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - }, - "Categories": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - }, - "Attachments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Attachment" - }, - "description": "" - }, - "Collections": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - }, - "SkuSellers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SkuSeller" - }, - "description": "" - }, - "SalesChannels": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "" - }, - "Images": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Image" - }, - "description": "" - }, - "SkuSpecifications": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SkuSpecification" - }, - "description": "" - }, - "ProductSpecifications": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSpecification" - }, - "description": "" - }, - "ProductClustersIds": { - "type": "string" - }, - "ProductCategoryIds": { - "type": "string" - }, - "ProductGlobalCategoryId": { - "type": "string", - "nullable": true - }, - "ProductCategories": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "CommercialConditionId": { - "type": "integer", - "format": "int32" - }, - "RewardValue": { - "type": "number" - }, - "AlternateIds": { - "$ref": "#/components/schemas/AlternateIds" - }, - "AlternateIdValues": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - }, - "EstimatedDateArrival": { - "type": "string", - "nullable": true - }, - "MeasurementUnit": { - "type": "string" - }, - "UnitMultiplier": { - "type": "number" - }, - "InformationSource": { - "type": "string", - "nullable": true - }, - "ModalType": { - "type": "string", - "nullable": true - } - }, - "example": { - "Id": 2001773, - "ProductId": 2001426, - "NameComplete": "Tabela de Basquete", - "ProductName": "Tabela de Basquete", - "ProductDescription": "Tabela de Basquete", - "SkuName": "Tabela de Basquete", - "IsActive": true, - "IsTransported": true, - "IsInventoried": true, - "IsGiftCardRecharge": false, - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168952-55-55/7508800GG.jpg", - "DetailUrl": "/tabela-de-basquete/p", - "CSCIdentification": null, - "BrandId": "2000018", - "BrandName": "MARCA ARGOLO TESTE", - "Dimension": { - "cubicweight": 81.6833, - "height": 65, - "length": 58, - "weight": 10000, - "width": 130 - }, - "RealDimension": { - "realCubicWeight": 274.1375, - "realHeight": 241, - "realLength": 65, - "realWeight": 9800, - "realWidth": 105 - }, - "ManufacturerCode": "", - "IsKit": false, - "KitItems": [], - "Services": [], - "Categories": [], - "Attachments": [ - { - "Id": 3, - "Name": "Mensagem", - "Keys": [ - "nome;20", - "foto;40" - ], - "Fields": [ - { - "FieldName": "nome", - "MaxCaracters": "20", - "DomainValues": "Adalberto,Pedro,João" - }, - { - "FieldName": "foto", - "MaxCaracters": "40", - "DomainValues": null - } - ], - "IsActive": true, - "IsRequired": false - } - ], - "Collections": [], - "SkuSellers": [ - { - "SellerId": "1", - "StockKeepingUnitId": 2001773, - "SellerStockKeepingUnitId": "2001773", - "IsActive": true, - "FreightCommissionPercentage": 0, - "ProductCommissionPercentage": 0 - } - ], - "SalesChannels": [ - 1, - 2, - 3, - 10 - ], - "Images": [ - { - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168952/7508800GG.jpg", - "ImageName": "", - "FileId": 168952 - }, - { - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168953/7508800_1GG.jpg", - "ImageName": "", - "FileId": 168953 - }, - { - "ImageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168954/7508800_2GG.jpg", - "ImageName": "", - "FileId": 168954 - } - ], - "SkuSpecifications": [ - { - "FieldId": 102, - "FieldName": "Cor", - "FieldValueIds": [ - 266 - ], - "FieldValues": [ - "Padrão" - ] - } - ], - "ProductSpecifications": [ - { - "FieldId": 7, - "FieldName": "Faixa Etária", - "FieldValueIds": [ - 58, - 56, - 55, - 52 - ], - "FieldValues": [ - "5 a 6 anos", - "7 a 8 anos", - "9 a 10 anos", - "Acima de 10 anos" - ] - }, - { - "FieldId": 23, - "FieldName": "Fabricante", - "FieldValueIds": [], - "FieldValues": [ - "Xalingo" - ] - } - ], - "ProductClustersIds": "176,187,192,194,211,217,235,242", - "ProductCategoryIds": "/59/", - "ProductGlobalCategoryId": null, - "ProductCategories": { - "59": "Brinquedos" - }, - "CommercialConditionId": 1, - "RewardValue": 100.0, - "AlternateIds": { - "Ean": "8781", - "RefId": "878181" - }, - "AlternateIdValues": [ - "8781", - "878181" - ], - "EstimatedDateArrival": "", - "MeasurementUnit": "un", - "UnitMultiplier": 1, - "InformationSource": null, - "ModalType": "" - } - }, - "example7": { - "title": "example7", - "required": [ - "IsPersisted", - "IsRemoved", - "Id", - "ProductId", - "IsActive", - "Name", - "Height", - "RealHeight", - "Width", - "RealWidth", - "Length", - "RealLength", - "WeightKg", - "RealWeightKg", - "ModalId", - "RefId", - "CubicWeight", - "IsKit", - "IsDynamicKit", - "InternalNote", - "DateUpdated", - "RewardValue", - "CommercialConditionId", - "EstimatedDateArrival", - "FlagKitItensSellApart", - "ManufacturerCode", - "ReferenceStockKeepingUnitId", - "Position", - "EditionSkuId", - "ApprovedAdminId", - "EditionAdminId", - "ActivateIfPossible", - "SupplierCode", - "MeasurementUnit", - "UnitMultiplier", - "IsInventoried", - "IsTransported", - "IsGiftCardRecharge", - "ModalType" - ], - "type": "object", - "properties": { - "IsPersisted": { - "type": "boolean" - }, - "IsRemoved": { - "type": "boolean" - }, - "Id": { - "type": "integer", - "format": "int32" - }, - "ProductId": { - "type": "integer", - "format": "int32" - }, - "IsActive": { - "type": "boolean" - }, - "Name": { - "type": "string" - }, - "Height": { - "type": "number" - }, - "RealHeight": { - "type": "number", - "nullable": true - }, - "Width": { - "type": "number" - }, - "RealWidth": { - "type": "number", - "nullable": true - }, - "Length": { - "type": "number" - }, - "RealLength": { - "type": "number", - "nullable": true - }, - "WeightKg": { - "type": "number" - }, - "RealWeightKg": { - "type": "number", - "nullable": true - }, - "ModalId": { - "type": "integer", - "format": "int32" - }, - "RefId": { - "type": "string" - }, - "CubicWeight": { - "type": "number" - }, - "IsKit": { - "type": "boolean" - }, - "IsDynamicKit": { - "type": "string", - "nullable": true - }, - "InternalNote": { - "type": "string", - "nullable": true - }, - "DateUpdated": { - "type": "string" - }, - "RewardValue": { - "type": "number", - "nullable": true - }, - "CommercialConditionId": { - "type": "integer", - "format": "int32" - }, - "EstimatedDateArrival": { - "type": "string", - "nullable": true - }, - "FlagKitItensSellApart": { - "type": "boolean" - }, - "ManufacturerCode": { - "type": "string" - }, - "ReferenceStockKeepingUnitId": { - "type": "string", - "nullable": true - }, - "Position": { - "type": "integer", - "format": "int32" - }, - "EditionSkuId": { - "type": "string", - "nullable": true - }, - "ApprovedAdminId": { - "type": "integer", - "format": "int32" - }, - "EditionAdminId": { - "type": "integer", - "format": "int32" - }, - "ActivateIfPossible": { - "type": "boolean" - }, - "SupplierCode": { - "type": "string", - "nullable": true - }, - "MeasurementUnit": { - "type": "string" - }, - "UnitMultiplier": { - "type": "number" - }, - "IsInventoried": { - "type": "string", - "nullable": true - }, - "IsTransported": { - "type": "string", - "nullable": true - }, - "IsGiftCardRecharge": { - "type": "string", - "nullable": true - }, - "ModalType": { - "type": "string", - "nullable": true - } - }, - "example": { - "IsPersisted": true, - "IsRemoved": false, - "Id": 2000035, - "ProductId": 2000024, - "IsActive": true, - "Name": "33 - Preto", - "Height": 8, - "RealHeight": null, - "Width": 15, - "RealWidth": null, - "Length": 8, - "RealLength": null, - "WeightKg": 340, - "RealWeightKg": null, - "ModalId": 1, - "RefId": "", - "CubicWeight": 0.2, - "IsKit": false, - "IsDynamicKit": null, - "InternalNote": null, - "DateUpdated": "2015-11-06T19:10:00", - "RewardValue": 0.01, - "CommercialConditionId": 1, - "EstimatedDateArrival": "", - "FlagKitItensSellApart": false, - "ManufacturerCode": "", - "ReferenceStockKeepingUnitId": null, - "Position": 0, - "EditionSkuId": null, - "ApprovedAdminId": 123, - "EditionAdminId": 123, - "ActivateIfPossible": true, - "SupplierCode": null, - "MeasurementUnit": "un", - "UnitMultiplier": 1, - "IsInventoried": null, - "IsTransported": null, - "IsGiftCardRecharge": null, - "ModalType": "" - } - }, - "Example8": { - "title": "Example8", - "required": [ - "D25133K-B2", - "14-556", - "123", - "DCF880L2-BR" - ], - "type": "object", - "properties": { - "123": { - "type": "string", - "nullable": true - }, - "D25133K-B2": { - "type": "string" - }, - "14-556": { - "type": "string" - }, - "DCF880L2-BR": { - "type": "string" - } - } - }, - "AssociateattachmentstoSKURequest": { - "title": "Associate attachments to SKU Request", - "required": [ - "SkuId", - "AttachmentNames" - ], - "type": "object", - "properties": { - "SkuId": { - "type": "integer", - "items": { - "type": "string", - "title": "SKU Name" - }, - "description": "SKU reference ID that you need identify the SKU IDs" - }, - "AttachmentNames": { - "type": "array", - "items": { - "type": "string", - "title": "Attachment Name" - }, - "description": "Array with all attachments name that you need to associate SKU" - } - } - }, - "CreateSellerRequest": { - "type": "object", - "title": "", - "required": [ - "SellerId", - "Name", - "Email", - "Description", - "ExchangeReturnPolicy", - "DeliveryPolicy", - "UseHybridPaymentOptions", - "UserName", - "Password", - "SecutityPrivacyPolicy", - "CNPJ", - "CSCIdentification", - "ArchiveId", - "UrlLogo", - "ProductCommissionPercentage", - "FreightCommissionPercentage", - "FulfillmentEndpoint", - "CatalogSystemEndpoint", - "IsActive", - "FulfillmentSellerId", - "SellerType", - "IsBetterScope" - ], - "properties": { - "SellerId": { - "type": "string", - "description": "Code used to identify the seller. It is assigned by the marketplace. We recommend filling it in with the seller's account name.", - "default": "pedrostore" - }, - "Name": { - "type": "string", - "description": "Name of the account in the seller's environment. You can find it on **Account settings > Account > Account Name**). Applicable only if the seller uses their own payment method.", - "default": "My pedrostore" - }, - "Email": { - "type": "string", - "description": "Email of the admin responsible for the seller. ", - "default": "breno@breno.com" - }, - "Description": { - "type": "string", - "description": "Text describing the seller with a marketing tone. You can display this text in the marketplace window display by [customizing the CMS](https://help.vtex.com/en/tutorial/list-of-controls-for-templates--tutorials_563).", - "default": "Brief description" - }, - "ExchangeReturnPolicy": { - "type": "string", - "description": "Text describing the exchange and return policy previously agreed between the marketplace and the seller.", - "default": "Exchange return policy text" - }, - "DeliveryPolicy": { - "type": "string", - "description": "Text describing the delivery policy previously agreed between the marketplace and the seller.", - "default": "Delivery policy text" - }, - "UseHybridPaymentOptions": { - "type": "boolean", - "description": "Allows customers to use gift cards from the seller to buy their products on the marketplace. It identifies purchases made with a gift card so that only the final price (with discounts applied) is paid to the seller. ", - "default": false - }, - "UserName": { - "type": "string", - "description": "Seller username.", - "default": "myseller" - }, - "Password": { - "type": "string", - "description": "Seller password.", - "default": "passoword" - }, - "SecutityPrivacyPolicy": { - "type": "string", - "description": "Text describing the security policy previously agreed between the marketplace and the seller.", - "default": "Secutity privacy policy text" - }, - "CNPJ": { - "type": "string", - "description": "Company registration number.", - "default": "12035072751" - }, - "CSCIdentification": { - "type": "string", - "description": "CSC identification.", - "default": "pedrostore" - }, - "ArchiveId": { - "type": "integer", - "description": "Seller archive ID.", - "default": "1" - }, - "UrlLogo": { - "type": "string", - "description": "Seller URL logo.", - "default": "/myseller" - }, - "ProductCommissionPercentage": { - "type": "number", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`.", - "default": 0.0 - }, - "FreightCommissionPercentage": { - "type": "number", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`.", - "default": 0.0 - }, - "CategoryCommissionPercentage": { - "type": "string", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`.", - "default": "[{\"CategoryId\":14,\"ProductCommission\":15.0,\"FreightCommission\":0.0}]" - }, - "FulfillmentEndpoint": { - "type": "string", - "description": "URL of the endpoint for fulfillment of seller's orders, which the marketplace will use to communicate with the seller. This field applies to all sellers, regardless of their type. However, for `VTEX Stores`, you don’t need to fill it in because the system will do that automatically. You can edit this field once the seller has been successfully added.", - "default": "http://pedrostore.vtexcommercestable.com.br/api/fulfillment?affiliateid=LDB&sc=1" - }, - "CatalogSystemEndpoint": { - "type": "string", - "description": "URL of the endpoint of the seller's catalog. This field will only be displayed if the seller type is VTEX Store. The field format will be as follows: `http://{sellerName}.vtexcommercestable.com.br/api/catalog_system/`.", - "default": "http://pedrostore.vtexcommercestable.com.br/api/catalog_system/" - }, - "IsActive": { - "type": "boolean", - "description": "If the selle is active (`true`) or not (`false`).", - "default": true - }, - "MerchantName": { - "type": "string", - "description": "Name of the marketplace, used to guide payments. This field should be nulled if the marketplace is responsible for processing payments. Check out our [Split Payment](https://help.vtex.com/en/tutorial/split-de-pagamento--6k5JidhYRUxileNolY2VLx) article to know more.", - "default": "pedrostore" - }, - "FulfillmentSellerId": { - "type": "integer", - "description": "Identification code of the seller responsible for fulfilling the order. This is an optional field used when a seller sells SKUs from another seller. If the seller sells their own SKUs, it must be left blank.", - "default": 1 - }, - "SellerType": { - "type": "integer", - "description": "Seller type.", - "default": 1 - }, - "IsBetterScope": { - "type": "boolean", - "description": "Indicates whether it is a [comprehensive seller](https://help.vtex.com/en/tutorial/comprehensive-seller--5Qn4O2GpjUIzWTPpvLUfkI).", - "default": false - }, - "TrustPolicy": { - "type": "string", - "description": "Seller trust policy. The default value is `'Default'`, but if your store is a B2B marketplace and you want to share the customers'emails with the sellers you need to set this field as `'AllowEmailSharing'`.", - "default": "Default" - } - } - }, - "UpdateSellerRequest": { - "type": "object", - "title": "", - "required": [ - "Name", - "Email", - "Description", - "ExchangeReturnPolicy", - "DeliveryPolicy", - "UseHybridPaymentOptions", - "UserName", - "Password", - "SecutityPrivacyPolicy", - "CNPJ", - "CSCIdentification", - "ArchiveId", - "UrlLogo", - "ProductCommissionPercentage", - "FreightCommissionPercentage", - "FulfillmentEndpoint", - "CatalogSystemEndpoint", - "IsActive", - "FulfillmentSellerId", - "SellerType", - "IsBetterScope" - ], - "properties": { - "Name": { - "type": "string", - "description": "Name of the account in the seller's environment. You can find it on **Account settings > Account > Account Name**). Applicable only if the seller uses their own payment method.", - "default": "My pedrostore" - }, - "Email": { - "type": "string", - "description": "Email of the admin responsible for the seller. ", - "default": "breno@breno.com" - }, - "Description": { - "type": "string", - "description": "Text describing the seller with a marketing tone. You can display this text in the marketplace window display by [customizing the CMS](https://help.vtex.com/en/tutorial/list-of-controls-for-templates--tutorials_563).", - "default": "Brief description" - }, - "ExchangeReturnPolicy": { - "type": "string", - "description": "Text describing the exchange and return policy previously agreed between the marketplace and the seller.", - "default": "Exchange return policy text" - }, - "DeliveryPolicy": { - "type": "string", - "description": "Text describing the delivery policy previously agreed between the marketplace and the seller.", - "default": "Delivery policy text" - }, - "UseHybridPaymentOptions": { - "type": "boolean", - "description": "Allows customers to use gift cards from the seller to buy their products on the marketplace. It identifies purchases made with a gift card so that only the final price (with discounts applied) is paid to the seller. ", - "default": false - }, - "UserName": { - "type": "string", - "description": "Seller username.", - "default": "myseller" - }, - "Password": { - "type": "string", - "description": "Seller password.", - "default": "passoword" - }, - "SecutityPrivacyPolicy": { - "type": "string", - "description": "Text describing the security policy previously agreed between the marketplace and the seller.", - "default": "Secutity privacy policy text" - }, - "CNPJ": { - "type": "string", - "description": "Company registration number.", - "default": "12035072751" - }, - "CSCIdentification": { - "type": "string", - "description": "CSC identification.", - "default": "pedrostore" - }, - "ArchiveId": { - "type": "integer", - "description": "Seller archive ID.", - "default": "1" - }, - "UrlLogo": { - "type": "string", - "description": "Seller URL logo.", - "default": "/myseller" - }, - "ProductCommissionPercentage": { - "type": "number", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`.", - "default": 0.0 - }, - "FreightCommissionPercentage": { - "type": "number", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`.", - "default": 0.0 - }, - "CategoryCommissionPercentage": { - "type": "string", - "description": "The percentage that must be filled in as agreed between the marketplace and the seller. If there is no such commission, please fill in the field with the value: `0.00`.", - "default": "[{\"CategoryId\":14,\"ProductCommission\":15.0,\"FreightCommission\":0.0}]" - }, - "FulfillmentEndpoint": { - "type": "string", - "description": "URL of the endpoint for fulfillment of seller's orders, which the marketplace will use to communicate with the seller. This field applies to all sellers, regardless of their type. However, for `VTEX Stores`, you don’t need to fill it in because the system will do that automatically. You can edit this field once the seller has been successfully added.", - "default": "http://pedrostore.vtexcommercestable.com.br/api/fulfillment?affiliateid=LDB&sc=1" - }, - "CatalogSystemEndpoint": { - "type": "string", - "description": "URL of the endpoint of the seller's catalog. This field will only be displayed if the seller type is VTEX Store. The field format will be as follows: `http://{sellerName}.vtexcommercestable.com.br/api/catalog_system/`.", - "default": "http://pedrostore.vtexcommercestable.com.br/api/catalog_system/" - }, - "IsActive": { - "type": "boolean", - "description": "If the selle is active (`true`) or not (`false`).", - "default": true - }, - "MerchantName": { - "type": "string", - "description": "Name of the marketplace, used to guide payments. This field should be nulled if the marketplace is responsible for processing payments. Check out our [Split Payment](https://help.vtex.com/en/tutorial/split-de-pagamento--6k5JidhYRUxileNolY2VLx) article to know more.", - "default": "pedrostore" - }, - "FulfillmentSellerId": { - "type": "integer", - "description": "Identification code of the seller responsible for fulfilling the order. This is an optional field used when a seller sells SKUs from another seller. If the seller sells their own SKUs, it must be left blank.", - "default": 1 - }, - "SellerType": { - "type": "integer", - "description": "Seller type.", - "default": 1 - }, - "IsBetterScope": { - "type": "boolean", - "description": "Indicates whether it is a [comprehensive seller](https://help.vtex.com/en/tutorial/comprehensive-seller--5Qn4O2GpjUIzWTPpvLUfkI).", - "default": false - }, - "TrustPolicy": { - "type": "string", - "description": "Seller trust policy. The default value is `'Default'`, but if your store is a B2B marketplace and you want to share the customers'emails with the sellers you need to set this field as `'AllowEmailSharing'`.", - "default": "Default" - } - } - }, - "GetSKUseller": { - "title": "GetSKUseller", - "required": [ - "IsPersisted", - "IsRemoved", - "SkuSellerId", - "SellerId", - "StockKeepingUnitId", - "SellerStockKeepingUnitId", - "IsActive", - "UpdateDate", - "RequestedUpdateDate" - ], - "type": "object", - "properties": { - "IsPersisted": { - "type": "boolean" - }, - "IsRemoved": { - "type": "boolean" - }, - "SkuSellerId": { - "type": "integer", - "format": "int32" - }, - "SellerId": { - "type": "string", - "description": "ID that identifies the seller in the marketplace. It can be the same as the seller name or a unique number. Check the **Sellers management** section in the Admin to get the correct ID." - }, - "StockKeepingUnitId": { - "type": "integer", - "format": "int32" - }, - "SellerStockKeepingUnitId": { - "type": "string" - }, - "IsActive": { - "type": "boolean" - }, - "UpdateDate": { - "type": "string" - }, - "RequestedUpdateDate": { - "type": "string", - "nullable": true - } - }, - "example": { - "IsPersisted": true, - "IsRemoved": false, - "SkuSellerId": 799, - "SellerId": "myseller", - "StockKeepingUnitId": 50, - "SellerStockKeepingUnitId": "502", - "IsActive": true, - "UpdateDate": "2018-10-11T04:52:42.1", - "RequestedUpdateDate": null - } - }, - "example9": { - "title": "example9", - "required": [ - "Name", - "CategoryId", - "FieldId", - "IsActive", - "IsStockKeepingUnit" - ], - "type": "object", - "properties": { - "Name": { - "type": "string" - }, - "CategoryId": { - "type": "integer", - "format": "int32", - "nullable": true - }, - "FieldId": { - "type": "integer", - "format": "int32" - }, - "IsActive": { - "type": "boolean" - }, - "IsStockKeepingUnit": { - "type": "boolean" - } - }, - "example": { - "Name": "Agenda", - "CategoryId": 1000025, - "FieldId": 822, - "IsActive": true, - "IsStockKeepingUnit": false - } - }, - "Example10": { - "title": "Example10", - "required": [ - "FieldValueId", - "Value", - "IsActive", - "Position" - ], - "type": "object", - "properties": { - "FieldValueId": { - "type": "integer", - "format": "int32" - }, - "Value": { - "type": "string" - }, - "IsActive": { - "type": "boolean" - }, - "Position": { - "type": "integer", - "format": "int32" - } - }, - "example": { - "FieldValueId": 52, - "Value": "0 a 6 meses", - "IsActive": true, - "Position": 1 - } - }, - "SpecificationsInsertFieldRequest": { - "title": "Request body", - "required": [ - "Name", - "CategoryId", - "IsActive", - "FieldId", - "IsRequired", - "FieldTypeId", - "FieldValueId", - "Description", - "IsStockKeepingUnit", - "IsFilter", - "IsOnProductDetails", - "Position", - "IsWizard", - "IsTopMenuLinkActive", - "IsSideMenuLinkActive", - "DefaultValue", - "FieldGroupId", - "FieldGroupName" - ], - "type": "object", - "properties": { - "Name": { - "type": "string", - "description": "Specification Field ID" - }, - "CategoryId": { - "type": "integer", - "nullable": true, - "description": "Category ID" - }, - "FieldId": { - "type": "integer", - "nullable": true, - "description": "Specification Field ID" - }, - "IsActive": { - "type": "boolean", - "description": "If the Specification Field is active, default value is true" - }, - "IsRequired": { - "type": "boolean", - "description": "If the Specification Field is required" - }, - "FieldTypeId": { - "type": "integer", - "format": "int32", - "description": "Specification Field Type ID" - }, - "FieldValueId": { - "type": "integer", - "nullable": true, - "description": "Specification Field Value ID" - }, - "Description": { - "type": "string", - "nullable": true, - "description": "Specification Field Description" - }, - "IsStockKeepingUnit": { - "type": "boolean", - "description": "If is a SKU Specification Field" - }, - "IsFilter": { - "type": "boolean", - "description": "If is a Filter Specification" - }, - "IsOnProductDetails": { - "type": "boolean", - "description": "If is visible in Product Page, default value is false" - }, - "Position": { - "type": "integer", - "format": "int32", - "description": "Specification Field Position" - }, - "IsWizard": { - "type": "boolean", - "description": "Obsolete Field" - }, - "IsTopMenuLinkActive": { - "type": "boolean", - "description": "If is visible in Top Menu, default value is false" - }, - "IsSideMenuLinkActive": { - "type": "boolean", - "description": "If is visible in Menu Link, default value is false" - }, - "DefaultValue": { - "type": "string", - "nullable": true, - "description": "Specification Field default Value" - }, - "FieldGroupId": { - "type": "integer", - "format": "int32", - "description": "Specification Field Group ID" - }, - "FieldGroupName": { - "type": "string", - "description": "Specification Field Group Name" - } - }, - "example": { - "Name": "FieldNameExample", - "CategoryId": null, - "IsActive": true, - "IsRequired": false, - "FieldTypeId": 5, - "FieldValueId": 1, - "Description": null, - "IsStockKeepingUnit": false, - "IsFilter": true, - "IsOnProductDetails": true, - "Position": 1, - "IsTopMenuLinkActive": true, - "IsSideMenuLinkActive": true, - "DefaultValue": null, - "FieldGroupId": 5 - } - }, - "SpecificationsInsertFieldUpdateRequest": { - "title": "Request body", - "required": [ - "Name", - "CategoryId", - "IsActive", - "FieldId", - "IsRequired", - "FieldTypeId", - "Description", - "IsStockKeepingUnit", - "IsFilter", - "IsOnProductDetails", - "Position", - "IsWizard", - "IsTopMenuLinkActive", - "IsSideMenuLinkActive", - "DefaultValue", - "FieldGroupId", - "FieldGroupName" - ], - "type": "object", - "properties": { - "Name": { - "type": "string", - "description": "Specification Field ID" - }, - "CategoryId": { - "type": "integer", - "nullable": true, - "description": "Category ID" - }, - "FieldId": { - "type": "integer", - "nullable": true, - "description": "Specification Field ID" - }, - "IsActive": { - "type": "boolean", - "description": "If the Specification Field is active, default value is true" - }, - "IsRequired": { - "type": "boolean", - "description": "If the Specification Field is required" - }, - "FieldTypeId": { - "type": "integer", - "format": "int32", - "description": "Specification Field Type ID" - }, - "FieldValueId": { - "type": "integer", - "nullable": true, - "description": "Specification Field Value ID" - }, - "Description": { - "type": "string", - "nullable": true, - "description": "Specification Field Description" - }, - "IsStockKeepingUnit": { - "type": "boolean", - "description": "If is a SKU Specification Field" - }, - "IsFilter": { - "type": "boolean", - "description": "If is a Filter Specification" - }, - "IsOnProductDetails": { - "type": "boolean", - "description": "If is visible in Product Page, default value is false" - }, - "Position": { - "type": "integer", - "format": "int32", - "description": "Specification Field Position" - }, - "IsWizard": { - "type": "boolean", - "description": "Obsolete Field" - }, - "IsTopMenuLinkActive": { - "type": "boolean", - "description": "If is visible in Top Menu, default value is false" - }, - "IsSideMenuLinkActive": { - "type": "boolean", - "description": "If is visible in Menu Link, default value is false" - }, - "DefaultValue": { - "type": "string", - "nullable": true, - "description": "Specification Field default Value" - }, - "FieldGroupId": { - "type": "integer", - "format": "int32", - "description": "Specification Field Group ID" - }, - "FieldGroupName": { - "type": "string", - "description": "Specification Field Group Name" - } - } - }, - "SpecificationsInsertFieldValueRequest": { - "title": "SpecificationsInsertFieldValueRequest", - "required": [ - "FieldId", - "Name", - "Text", - "IsActive", - "Position" - ], - "type": "object", - "properties": { - "FieldId": { - "type": "integer", - "format": "int32", - "description": "Specification Field ID" - }, - "Name": { - "type": "string", - "description": "Specification Field Value Name" - }, - "Text": { - "type": "string", - "description": "Specification Field Value Description" - }, - "IsActive": { - "type": "boolean", - "description": "If the Specification Field Value is active" - }, - "Position": { - "type": "integer", - "format": "int32", - "description": "Specification Field Value Position" - } - }, - "example": { - "FieldId": 34, - "Name": "TesteInsert", - "Text": "Value Description", - "IsActive": true, - "Position": 100 - } - }, - "SpecificationsUpdateFieldValueRequest": { - "title": "Request body", - "required": [ - "FieldId", - "Name", - "Text", - "IsActive", - "Position" - ], - "type": "object", - "properties": { - "FieldId": { - "type": "integer", - "nullable": true, - "description": "Specification Field ID" - }, - "Name": { - "type": "string", - "description": "Specification Field Value Name" - }, - "Text": { - "type": "string", - "nullable": true, - "description": "Specification Field Value Description" - }, - "IsActive": { - "type": "boolean", - "description": "If the Specification Field is active, default value is true" - }, - "Position": { - "type": "integer", - "format": "int32", - "description": "Specification Field Position" - } - }, - "example": { - "FieldValueId": 276, - "Name": "TesteInsertUpdate", - "Text": "Value Description2", - "IsActive": true, - "Position": 100 - } - }, - "example11": { - "title": "example11", - "required": [ - "CategoryId", - "Id", - "Name", - "Position" - ], - "type": "object", - "properties": { - "CategoryId": { - "type": "string", - "nullable": true - }, - "Id": { - "type": "integer", - "format": "int32" - }, - "Name": { - "type": "string" - }, - "Position": { - "type": "integer", - "format": "int32" - } - }, - "example": { - "CategoryId": null, - "Id": 5, - "Name": "Primeiro Grupo", - "Position": 2 - } - }, - "example12": { - "title": "example12", - "required": [ - "CategoryId", - "Id", - "Name", - "Position" - ], - "type": "object", - "properties": { - "CategoryId": { - "type": "string", - "nullable": true - }, - "Id": { - "type": "integer", - "format": "int32" - }, - "Name": { - "type": "string" - }, - "Position": { - "type": "integer", - "format": "int32", - "nullable": true - } - }, - "example": { - "CategoryId": null, - "Id": 4, - "Name": "Filtros", - "Position": 1 - } - }, - "SpecificationGroupInsertRequest": { - "title": "Request body", - "required": [ - "CategoryId", - "Name" - ], - "type": "object", - "properties": { - "CategoryId": { - "type": "integer", - "format": "int32", - "description": "Category ID" - }, - "Name": { - "type": "string", - "description": "Specification Group Name" - } - }, - "example": { - "CategoryId": 1, - "Name": "GroupName1" - } - }, - "example13": { - "title": "example13", - "required": [ - "CategoryId", - "Id", - "Name", - "Position" - ], - "type": "object", - "properties": { - "CategoryId": { - "type": "integer", - "format": "int32" - }, - "Id": { - "type": "integer", - "format": "int32" - }, - "Name": { - "type": "string" - }, - "Position": { - "type": "integer", - "format": "int32" - } - }, - "example": { - "CategoryId": 1, - "Id": 28, - "Name": "GroupName", - "Position": 3 - } - }, - "SpecificationGroupUpdateRequest": { - "title": "SpecificationGroupUpdateRequest", - "required": [ - "Id", - "Name" - ], - "type": "object", - "properties": { - "Id": { - "type": "integer", - "format": "int32", - "description": "Specification Group ID" - }, - "Name": { - "type": "string", - "description": "Specification Group Name" - } - }, - "example": { - "Id": 31, - "Name": "NewGroupName" - } - } - } - }, - "tags": [ - { - "name": "SKU Service" - }, - { - "name": "SKU Service Attachment" - }, - { - "name": "SKU Service Value" - }, - { - "name": "SKU Service Type" - }, - { - "name": "Category" - }, - { - "name": "Brand" - }, - { - "name": "Attachment" - }, - { - "name": "Product" - }, - { - "name": "Product Specification" - }, - { - "name": "Trade Policy" - }, - { - "name": "Similar Category" - }, - { - "name": "SKU" - }, - { - "name": "SKU EAN" - }, - { - "name": "SKU File" - }, - { - "name": "SKU Kit" - }, - { - "name": "SKU Specification" - }, - { - "name": "SKU Attachment" - }, - { - "name": "SKU Complement" - }, - { - "name": "Non Structured Specification" - }, - { - "name": "Specification Field" - }, - { - "name": "Specification Group" - }, - { - "name": "Specification Value" - }, - { - "name": "Specification Field Value" - }, - { - "name": "Category Specification" - }, - { - "name": "Specification" - }, - { - "name": "Collection" - }, - { - "name": "Collection Beta" - }, - { - "name": "Collection CMS" - }, - { - "name": "Subcollection" - }, - { - "name": "SKU Subcollection" - }, - { - "name": "Category Subcollection" - }, - { - "name": "Brand Subcollection" - }, - { - "name": "Supplier" - }, - { - "name": "Sales Channel" - }, - { - "name": "Seller" - }, - { - "name": "SKU Seller" - }, - { - "name": "Product Indexed" - }, - { - "name": "Commercial Conditions" - } - ] -} \ No newline at end of file diff --git a/public/docs/api-reference/Checkout-API.json b/public/docs/api-reference/Checkout-API.json deleted file mode 100644 index 70206fb2..00000000 --- a/public/docs/api-reference/Checkout-API.json +++ /dev/null @@ -1,8595 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "Checkout API", - "description": "Endpoints that deal with to shopping cart management and order placement.", - "contact": {}, - "version": "1.0" - }, - "servers": [ - { - "url": "https://{accountName}.{environment}.com.br", - "description": "VTEX server url", - "variables": { - "accountName": { - "description": "Name of the VTEX account. Used as part of the URL", - "default": "{accountName}" - }, - "environment": { - "description": "Environment to use. Used as part of the URL.", - "default": "{environment}" - } - } - } - ], - "paths": { - "/api/checkout/pub/orderForms/simulation": { - "post": { - "tags": [ - "Shopping cart" - ], - "summary": "Cart simulation", - "description": "This endpoint is used to simulate a cart in VTEX Checkout.\r\n\r\nIt receives an **SKU ID**, the **quantity** of items in the cart, the ID of the **Seller** and the **country** in ISO ALPHA-3 Code (eg. BRA, USA, ARG).\r\n\r\nIt sends back all information about the cart, such as the selling price of each item, rates and benefits data, payment and logistics info.\r\n\r\nThis is useful whenever you need to know the avaiability of fulfilling an order for a specific cart setting, since the API response will let you know the updated price, inventory and shipping data.", - "operationId": "CartSimulation", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "RnbBehavior", - "in": "query", - "description": "This parameter defines which promotions apply to the simulation. Use `1` for simulations at cart stage, which means all promotions apply. In case of window simulation use `0`, which indicates promotions that apply nominal discounts over the total purchase value shouldn't be considered on the simulation.\n\r\n\rNote that if this not sent, the parameter is `0`.", - "required": false, - "style": "form", - "schema": { - "type": "integer", - "default": 0 - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderFormSimulationRequest" - }, - "example": { - "items": [ - { - "id": "{{skuId}}", - "quantity": 1, - "seller": "1" - } - ], - "country": "{{countryCode-ISO-3-digits}}" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "items": [ - { - "id": "1", - "requestIndex": 0, - "quantity": 1, - "seller": "1", - "sellerChain": [ - "1" - ], - "tax": 0, - "priceValidUntil": "2021-02-27T13:57:49.7009186Z", - "price": 15000, - "listPrice": 30000, - "rewardValue": 0, - "sellingPrice": 15000, - "offerings": [], - "priceTags": [], - "measurementUnit": "un", - "unitMultiplier": 1.0, - "parentItemIndex": null, - "parentAssemblyBinding": null, - "availability": "available" - } - ], - "ratesAndBenefitsData": { - "rateAndBenefitsIdentifiers": [], - "teaser": [] - }, - "paymentData": { - "installmentOptions": [ - { - "paymentSystem": "2", - "bin": null, - "paymentName": "Visa", - "paymentGroupName": "creditCardPaymentGroup", - "value": 15000, - "installments": [ - { - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 15000, - "total": 15000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 15000, - "total": 15000 - } - ] - }, - { - "count": 2, - "hasInterestRate": false, - "interestRate": 0, - "value": 7500, - "total": 15000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 2, - "hasInterestRate": false, - "interestRate": 0, - "value": 7500, - "total": 15000 - } - ] - } - ] - }, - { - "paymentSystem": "4", - "bin": null, - "paymentName": "Mastercard", - "paymentGroupName": "creditCardPaymentGroup", - "value": 15000, - "installments": [ - { - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 15000, - "total": 15000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 15000, - "total": 15000 - } - ] - }, - { - "count": 2, - "hasInterestRate": false, - "interestRate": 0, - "value": 7500, - "total": 15000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 2, - "hasInterestRate": false, - "interestRate": 0, - "value": 7500, - "total": 15000 - } - ] - }, - { - "count": 3, - "hasInterestRate": false, - "interestRate": 0, - "value": 5000, - "total": 15000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 3, - "hasInterestRate": false, - "interestRate": 0, - "value": 5000, - "total": 15000 - } - ] - } - ] - }, - { - "paymentSystem": "6", - "bin": null, - "paymentName": "Boleto Bancário", - "paymentGroupName": "bankInvoicePaymentGroup", - "value": 15000, - "installments": [ - { - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 15000, - "total": 15000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 15000, - "total": 15000 - } - ] - } - ] - }, - { - "paymentSystem": "44", - "bin": null, - "paymentName": "Venda Direta Debito", - "paymentGroupName": "debitDirectSalePaymentGroup", - "value": 15000, - "installments": [ - { - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 15000, - "total": 15000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 15000, - "total": 15000 - } - ] - } - ] - } - ], - "paymentSystems": [ - { - "id": 6, - "name": "Boleto Bancário", - "groupName": "bankInvoicePaymentGroup", - "validator": null, - "stringId": "6", - "template": "bankInvoicePaymentGroup-template", - "requiresDocument": false, - "isCustom": false, - "description": null, - "requiresAuthentication": false, - "dueDate": "2020-03-05T13:57:49.664939Z", - "availablePayments": null - }, - { - "id": 4, - "name": "Mastercard", - "groupName": "creditCardPaymentGroup", - "validator": null, - "stringId": "4", - "template": "creditCardPaymentGroup-template", - "requiresDocument": false, - "isCustom": false, - "description": null, - "requiresAuthentication": false, - "dueDate": "2020-03-05T13:57:49.664939Z", - "availablePayments": null - }, - { - "id": 2, - "name": "Visa", - "groupName": "creditCardPaymentGroup", - "validator": null, - "stringId": "2", - "template": "creditCardPaymentGroup-template", - "requiresDocument": false, - "isCustom": false, - "description": null, - "requiresAuthentication": false, - "dueDate": "2020-03-05T13:57:49.664939Z", - "availablePayments": null - } - ], - "payments": [], - "giftCards": [], - "giftCardMessages": [], - "availableAccounts": [], - "availableTokens": [] - }, - "selectableGifts": [], - "marketingData": null, - "postalCode": null, - "country": "BRA", - "logisticsInfo": [ - { - "itemIndex": 0, - "addressId": null, - "selectedSla": null, - "selectedDeliveryChannel": null, - "quantity": 1, - "shipsTo": [ - "BRA" - ], - "slas": [], - "deliveryChannels": [ - { - "id": "pickup-in-point" - }, - { - "id": "delivery" - } - ] - } - ], - "messages": [], - "purchaseConditions": { - "itemPurchaseConditions": [ - { - "id": "1", - "seller": "1", - "sellerChain": [ - "1" - ], - "slas": [], - "price": 15000, - "listPrice": 30000 - } - ] - }, - "pickupPoints": [], - "subscriptionData": null, - "totals": [ - { - "id": "Items", - "name": "Total dos Itens", - "value": 15000 - } - ], - "itemMetadata": null - } - } - } - } - }, - "deprecated": false - } - }, - "/api/checkout/pub/orderForm": { - "get": { - "tags": [ - "Shopping cart" - ], - "summary": "Get current cart or create a new one", - "description": "This request allows you to obtain information of an existing shopping cart or to create a new empty one. VTEX checkout provides browsers with a cookie containing an `orderFormId`. Sending this request with such a cookie retrieves information of the cart corresponding to that ID. Without the cookie, this request creates and retrieves a new shopping cart.\r\n\r\nThe [orderForm](https://developers.vtex.com/vtex-rest-api/reference/checkout-api-overview) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` obtained in response is the identification code of the newly created cart.\n\r\n\r> This request has a time out of 45 seconds.", - "operationId": "GetCurrentCartOrCreateANewOne", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "orderFormId": "9ceee0fde6db489fbc682a0e2ab13a86", - "salesChannel": "1", - "loggedIn": false, - "isCheckedIn": false, - "storeId": null, - "checkedInPickupPointId": null, - "allowManualPrice": false, - "canEditData": true, - "userProfileId": null, - "userType": null, - "ignoreProfileData": false, - "value": 0, - "messages": [], - "items": [], - "selectableGifts": [], - "totalizers": [], - "shippingData": null, - "clientProfileData": { - "email": null, - "firstName": null, - "lastName": null, - "document": null, - "documentType": null, - "phone": null, - "corporateName": null, - "tradeName": null, - "corporateDocument": null, - "stateInscription": null, - "corporatePhone": null, - "isCorporate": false, - "profileCompleteOnLoading": null, - "profileErrorOnLoading": null, - "customerClass": null - }, - "paymentData": { - "installmentOptions": [], - "paymentSystems": [], - "payments": [], - "giftCards": [], - "giftCardMessages": [], - "availableAccounts": [], - "availableTokens": [] - }, - "marketingData": null, - "sellers": [], - "clientPreferencesData": { - "locale": "pt-BR", - "optinNewsLetter": null - }, - "commercialConditionData": null, - "storePreferencesData": { - "countryCode": "BRA", - "saveUserData": true, - "timeZone": "E. South America Standard Time", - "currencyCode": "BRL", - "currencyLocale": 1046, - "currencySymbol": "R$", - "currencyFormatInfo": { - "currencyDecimalDigits": 2, - "currencyDecimalSeparator": ",", - "currencyGroupSeparator": ".", - "currencyGroupSize": 3, - "startsWithCurrencySymbol": true - } - }, - "giftRegistryData": null, - "openTextField": null, - "invoiceData": null, - "customData": null, - "itemMetadata": null, - "hooksData": null, - "ratesAndBenefitsData": null, - "subscriptionData": null, - "itemsOrdination": null - } - } - } - } - }, - "deprecated": false - } - }, - "/api/checkout/pub/orderForm/{orderFormId}": { - "get": { - "tags": [ - "Shopping cart" - ], - "summary": "Get cart information by ID", - "description": "Use this request to get all information associated to a given shopping cart.\r\n\r\nThe [orderForm](https://developers.vtex.com/vtex-rest-api/reference/checkout-api-overview) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\r> This request has a time out of 45 seconds.", - "operationId": "GetCartInformationById", - "parameters": [ - { - "name": "orderFormId", - "in": "path", - "description": "ID of the orderForm corresponding to the cart whose information you want to retrieve.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "ede846222cd44046ba6c638442c3505a" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "refreshOutdatedData", - "in": "query", - "description": "It is possible to use the [Update cart items request](https://developers.vtex.com/vtex-rest-api/reference/cart-update#itemsupdate) so as to allow outdated information in the `orderForm`, which may improve performance in some cases. To guarantee that all cart information is updated, send this request with this parameter as `true`. We recommend doing this in the final stages of the shopping experience, starting from the checkout page.", - "required": false, - "style": "form", - "schema": { - "type": "boolean", - "default": true - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "application/json": { - "example": { - "orderFormId": "ede846222cd44046ba6c638442c3505a", - "salesChannel": "1", - "loggedIn": false, - "isCheckedIn": false, - "storeId": null, - "checkedInPickupPointId": null, - "allowManualPrice": false, - "canEditData": true, - "userProfileId": null, - "userType": null, - "ignoreProfileData": false, - "value": 15000, - "messages": [], - "items": [ - { - "uniqueId": "E0F2B7AF5CD74D668F1E27537206912C", - "id": "1", - "productId": "1", - "productRefId": "", - "refId": "0001", - "ean": "123456789", - "name": "Ração Royal Canin Feline Urinary 500g", - "skuName": "Ração Royal Canin Feline Urinary 500g", - "modalType": null, - "parentItemIndex": null, - "parentAssemblyBinding": null, - "assemblies": [], - "priceValidUntil": "2021-02-27T14:59:00.8288784Z", - "tax": 0, - "price": 15000, - "listPrice": 30000, - "manualPrice": null, - "sellingPrice": 15000, - "rewardValue": 0, - "isGift": false, - "additionalInfo": { - "brandName": "Royal Canin", - "brandId": "2000000", - "offeringInfo": null, - "offeringType": null, - "offeringTypeId": null - }, - "preSaleDate": null, - "productCategoryIds": "/1/10/", - "productCategories": { - "10": "Ração Seca", - "1": "Alimentação" - }, - "quantity": 1, - "seller": "1", - "sellerChain": [ - "1" - ], - "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000", - "detailUrl": "/racao-royal-canin-feline-urinary/p", - "components": [], - "bundleItems": [], - "attachments": [], - "attachmentOfferings": [], - "offerings": [], - "priceTags": [], - "availability": "available", - "measurementUnit": "un", - "unitMultiplier": 1.0, - "manufacturerCode": null - } - ], - "selectableGifts": [], - "totalizers": [ - { - "id": "Items", - "name": "Total dos Itens", - "value": 15000 - } - ], - "shippingData": { - "address": null, - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": null, - "selectedDeliveryChannel": null, - "addressId": null, - "slas": [], - "shipsTo": [ - "BRA" - ], - "itemId": "1", - "deliveryChannels": [ - { - "id": "pickup-in-point" - }, - { - "id": "delivery" - } - ] - } - ], - "selectedAddresses": [], - "availableAddresses": [], - "pickupPoints": [] - }, - "clientProfileData": { - "email": "clark.kent@examplemail.com", - "firstName": "Clark", - "lastName": "Kent", - "document": "12345678900", - "documentType": "cpf", - "phone": "+5500123456789", - "corporateName": null, - "tradeName": null, - "corporateDocument": null, - "stateInscription": null, - "corporatePhone": null, - "isCorporate": false, - "profileCompleteOnLoading": false, - "profileErrorOnLoading": false, - "customerClass": null - }, - "paymentData": { - "installmentOptions": [ - { - "paymentSystem": "2", - "bin": null, - "paymentName": null, - "paymentGroupName": null, - "value": 15000, - "installments": [ - { - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 15000, - "total": 15000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 15000, - "total": 15000 - } - ] - }, - { - "count": 2, - "hasInterestRate": false, - "interestRate": 0, - "value": 7500, - "total": 15000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 2, - "hasInterestRate": false, - "interestRate": 0, - "value": 7500, - "total": 15000 - } - ] - } - ] - } - ], - "paymentSystems": [ - { - "id": 2, - "name": "Visa", - "groupName": "creditCardPaymentGroup", - "validator": { - "regex": "^2[1-8]{17}$", - "mask": "9999 9999 9999 9999", - "cardCodeRegex": "^[0-3]{8}$", - "cardCodeMask": "999", - "weights": [ - 2, - 1, - 2, - 1, - 2, - 1 - ], - "useCvv": true, - "useExpirationDate": true, - "useCardHolderName": true, - "useBillingAddress": true - }, - "stringId": "2", - "template": "creditCardPaymentGroup-template", - "requiresDocument": false, - "isCustom": false, - "description": null, - "requiresAuthentication": false, - "dueDate": "2020-03-05T14:59:00.7879306Z", - "availablePayments": null - } - ], - "payments": [], - "giftCards": [], - "giftCardMessages": [], - "availableAccounts": [], - "availableTokens": [] - }, - "marketingData": null, - "sellers": [ - { - "id": "1", - "name": "lojadobreno", - "logo": "" - } - ], - "clientPreferencesData": { - "locale": "pt-BR", - "optinNewsLetter": null - }, - "commercialConditionData": null, - "storePreferencesData": { - "countryCode": "BRA", - "saveUserData": true, - "timeZone": "E. South America Standard Time", - "currencyCode": "BRL", - "currencyLocale": 1046, - "currencySymbol": "R$", - "currencyFormatInfo": { - "currencyDecimalDigits": 2, - "currencyDecimalSeparator": ",", - "currencyGroupSeparator": ".", - "currencyGroupSize": 3, - "startsWithCurrencySymbol": true - } - }, - "giftRegistryData": null, - "openTextField": null, - "invoiceData": null, - "customData": null, - "itemMetadata": { - "items": [ - { - "id": "1", - "seller": "1", - "name": "Ração Royal Canin Feline Urinary 500g", - "skuName": "Ração Royal Canin Feline Urinary 500g", - "productId": "1", - "refId": "0001", - "ean": "123456789", - "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000", - "detailUrl": "/racao-royal-canin-feline-urinary/p", - "assemblyOptions": [] - } - ] - }, - "hooksData": null, - "ratesAndBenefitsData": { - "rateAndBenefitsIdentifiers": [], - "teaser": [] - }, - "subscriptionData": null, - "itemsOrdination": null - } - } - } - } - }, - "deprecated": false - } - }, - "/api/checkout/pub/orderForm/{orderFormId}/items/removeAll": { - "post": { - "tags": [ - "Shopping cart" - ], - "summary": "Remove all items", - "description": "This request removes all items from a given cart, leaving it empty.\r\n\r\nYou must send an empty JSON in the body of the request.\r\n\r\nThe [orderForm](https://developers.vtex.com/vtex-rest-api/reference/checkout-api-overview) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.", - "operationId": "RemoveAllItems", - "parameters": [ - { - "name": "orderFormId", - "in": "path", - "description": "ID of the orderForm corresponding to the cart whose items you want to remove.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "ede846222cd44046ba6c638442c3505a" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "This object must be empty.", - "title": "", - "properties": {}, - "default": {} - } - } - } - }, - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "examples": { - "response": { - "value": { - "orderFormId": "ede846222cd44046ba6c638442c3505a", - "salesChannel": "1", - "loggedIn": false, - "isCheckedIn": false, - "storeId": null, - "checkedInPickupPointId": null, - "allowManualPrice": false, - "canEditData": true, - "userProfileId": null, - "userType": null, - "ignoreProfileData": false, - "value": 0, - "messages": [], - "items": [], - "selectableGifts": [], - "totalizers": [], - "shippingData": { - "address": null, - "logisticsInfo": [], - "selectedAddresses": [], - "availableAddresses": [], - "pickupPoints": [] - }, - "clientProfileData": { - "email": "john.doe@google.com", - "firstName": "John", - "lastName": "Doe", - "document": "769387308", - "documentType": "dni", - "phone": "+5491111223344", - "corporateName": null, - "tradeName": null, - "corporateDocument": null, - "stateInscription": null, - "corporatePhone": null, - "isCorporate": false, - "profileCompleteOnLoading": false, - "profileErrorOnLoading": false, - "customerClass": null - }, - "paymentData": { - "installmentOptions": [ - { - "paymentSystem": "2", - "bin": null, - "paymentName": null, - "paymentGroupName": null, - "value": 15000, - "installments": [ - { - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 15000, - "total": 15000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 15000, - "total": 15000 - } - ] - } - ] - } - ], - "paymentSystems": [ - { - "id": 4, - "name": "Mastercard", - "groupName": "creditCardPaymentGroup", - "validator": { - "regex": "^((5(([1-2]|[5-5])[0-3]{8}|0((2|9)([0-2]{5}))|1(0(5((0|[4-8])[1-7]{6})|([2-3]|[1-9])[0-9]{6})|[1-9][0-9]{7})))|((508116)\\d{4,10})|((502121)\\d{4,10})|((589916)\\d{4,10})|(2[0-9]{15})|(67[0-9]{14})|(506387)\\d{4,10})", - "mask": "9999 9999 9999 9999", - "cardCodeRegex": "^[1-3]{9}$", - "cardCodeMask": "999", - "weights": [ - 2, - 1, - 2, - 1, - 2 - ], - "useCvv": true, - "useExpirationDate": true, - "useCardHolderName": true, - "useBillingAddress": true - }, - "stringId": "4", - "template": "creditCardPaymentGroup-template", - "requiresDocument": false, - "isCustom": false, - "description": null, - "requiresAuthentication": false, - "dueDate": "2020-03-05T14:23:23.8196668Z", - "availablePayments": null - } - ], - "payments": [], - "giftCards": [], - "giftCardMessages": [], - "availableAccounts": [], - "availableTokens": [] - }, - "marketingData": null, - "sellers": [], - "clientPreferencesData": { - "locale": "pt-BR", - "optinNewsLetter": null - }, - "commercialConditionData": null, - "storePreferencesData": { - "countryCode": "BRA", - "saveUserData": true, - "timeZone": "E. South America Standard Time", - "currencyCode": "BRL", - "currencyLocale": 1046, - "currencySymbol": "R$", - "currencyFormatInfo": { - "currencyDecimalDigits": 2, - "currencyDecimalSeparator": ",", - "currencyGroupSeparator": ".", - "currencyGroupSize": 3, - "startsWithCurrencySymbol": true - } - }, - "giftRegistryData": null, - "openTextField": null, - "invoiceData": null, - "customData": null, - "itemMetadata": { - "items": [] - }, - "hooksData": null, - "ratesAndBenefitsData": null, - "subscriptionData": null, - "itemsOrdination": null - } - } - } - } - } - } - }, - "deprecated": false - } - }, - "/checkout/changeToAnonymousUser/{orderFormId}": { - "get": { - "tags": [ - "Shopping cart" - ], - "summary": "Remove all personal data", - "description": "This call removes all user information, making a cart anonymous, while leaving the items.\r\n\r\nThe [orderForm](https://developers.vtex.com/vtex-rest-api/reference/checkout-api-overview) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\r\n\r\nThis call works by creating a new orderForm, setting a new cookie and returning a redirect 302 to the cart URL (`/checkout/#/orderform`).", - "operationId": "Removeallpersonaldata", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "orderFormId", - "in": "path", - "description": "ID of the orderForm corresponding to the cart whose user's personal data you want to remove.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "ede846222cd44046ba6c638442c3505a" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "schema": { - "type": "object" - }, - "example": {} - } - } - } - }, - "deprecated": false - } - }, - "/api/checkout/pub/orderForm/{orderFormId}/items": { - "patch": { - "tags": [ - "Shopping cart" - ], - "summary": "Update cart items", - "description": "With the items update request you can:\n\r\n\r1. Add items to the cart;\n\r2. Change the quantity of one or more items in a specific cart;\n\r3. Remove items from the cart (by changing their quantity to 0).\r\n\r\nThe [orderForm](https://developers.vtex.com/vtex-rest-api/reference/checkout-api-overview) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\r> This request has a time out of 45 seconds.", - "operationId": "ItemsUpdate", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "orderFormId", - "in": "path", - "description": "ID of the orderForm corresponding to the cart whose items you want to update.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "ede846222cd44046ba6c638442c3505a" - } - }, - { - "name": "allowOutdatedData", - "in": "query", - "description": "In order to optimize performance, this parameter allows some information to not be updated when there are changes in the minicart. For instance, if a shopper adds another unit of a given SKU to the cart, it may not be necessary to recalculate payment information, which could impact performance.\n\r\n\rThis array accepts strings and currently the only possible value is `”paymentData”`.", - "required": false, - "style": "form", - "schema": { - "type": "array", - "default": [ - "paymentData" - ], - "items": {} - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "orderItems": { - "type": "array", - "description": "Array containing the cart items. Each object inside this array corresponds to a different item.", - "items": { - "required": [ - "quantity", - "seller", - "id" - ], - "type": "object", - "properties": { - "quantity": { - "type": "integer", - "format": "int32", - "description": "The quantity of the item the cart.", - "example": 3 - }, - "seller": { - "type": "string", - "description": "The seller responsible for the SKU.", - "example": "1" - }, - "id": { - "type": "string", - "description": "The ID of the SKU in VTEX platform.", - "example": "2005" - }, - "price": { - "type": "integer", - "description": "Price of the item in cents. Send this value in case you want to make a bulk price change.", - "example": 1099 - } - } - } - } - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "orderFormId": "ede846222cd44046ba6c638442c3505a", - "salesChannel": "1", - "loggedIn": false, - "isCheckedIn": false, - "storeId": null, - "checkedInPickupPointId": null, - "allowManualPrice": false, - "canEditData": true, - "userProfileId": null, - "userType": null, - "ignoreProfileData": false, - "value": 15000, - "messages": [], - "items": [ - { - "uniqueId": "E0F2B7AF5CD74D668F1E27537206912C", - "id": "1", - "productId": "1", - "productRefId": "", - "refId": "0001", - "ean": "123456789", - "name": "Ração Royal Canin Feline Urinary 500g", - "skuName": "Ração Royal Canin Feline Urinary 500g", - "modalType": null, - "parentItemIndex": null, - "parentAssemblyBinding": null, - "assemblies": [], - "priceValidUntil": "2021-02-27T14:59:00.8288784Z", - "tax": 0, - "price": 15000, - "listPrice": 30000, - "manualPrice": null, - "sellingPrice": 15000, - "rewardValue": 0, - "isGift": false, - "additionalInfo": { - "brandName": "Royal Canin", - "brandId": "2000000", - "offeringInfo": null, - "offeringType": null, - "offeringTypeId": null - }, - "preSaleDate": null, - "productCategoryIds": "/1/10/", - "productCategories": { - "10": "Ração Seca", - "1": "Alimentação" - }, - "quantity": 1, - "seller": "1", - "sellerChain": [ - "1" - ], - "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000", - "detailUrl": "/racao-royal-canin-feline-urinary/p", - "components": [], - "bundleItems": [], - "attachments": [], - "attachmentOfferings": [], - "offerings": [], - "priceTags": [], - "availability": "available", - "measurementUnit": "un", - "unitMultiplier": 1.0, - "manufacturerCode": null - } - ], - "selectableGifts": [], - "totalizers": [ - { - "id": "Items", - "name": "Total dos Itens", - "value": 15000 - } - ], - "shippingData": { - "address": null, - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": null, - "selectedDeliveryChannel": null, - "addressId": null, - "slas": [], - "shipsTo": [ - "BRA" - ], - "itemId": "1", - "deliveryChannels": [ - { - "id": "pickup-in-point" - }, - { - "id": "delivery" - } - ] - } - ], - "selectedAddresses": [], - "availableAddresses": [], - "pickupPoints": [] - }, - "clientProfileData": null, - "paymentData": { - "installmentOptions": [ - { - "paymentSystem": "2", - "bin": null, - "paymentName": null, - "paymentGroupName": null, - "value": 15000, - "installments": [ - { - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 15000, - "total": 15000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 15000, - "total": 15000 - } - ] - }, - { - "count": 2, - "hasInterestRate": false, - "interestRate": 0, - "value": 7500, - "total": 15000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 2, - "hasInterestRate": false, - "interestRate": 0, - "value": 7500, - "total": 15000 - } - ] - } - ] - } - ], - "paymentSystems": [ - { - "id": 2, - "name": "Visa", - "groupName": "creditCardPaymentGroup", - "validator": { - "regex": "^2[1-8]{17}$", - "mask": "9999 9999 9999 9999", - "cardCodeRegex": "^[0-3]{8}$", - "cardCodeMask": "999", - "weights": [ - 2, - 1, - 2, - 1, - 2, - 1 - ], - "useCvv": true, - "useExpirationDate": true, - "useCardHolderName": true, - "useBillingAddress": true - }, - "stringId": "2", - "template": "creditCardPaymentGroup-template", - "requiresDocument": false, - "isCustom": false, - "description": null, - "requiresAuthentication": false, - "dueDate": "2020-03-05T14:59:00.7879306Z", - "availablePayments": null - } - ], - "payments": [], - "giftCards": [], - "giftCardMessages": [], - "availableAccounts": [], - "availableTokens": [] - }, - "marketingData": null, - "sellers": [ - { - "id": "1", - "name": "lojadobreno", - "logo": "" - } - ], - "clientPreferencesData": { - "locale": "pt-BR", - "optinNewsLetter": null - }, - "commercialConditionData": null, - "storePreferencesData": { - "countryCode": "BRA", - "saveUserData": true, - "timeZone": "E. South America Standard Time", - "currencyCode": "BRL", - "currencyLocale": 1046, - "currencySymbol": "R$", - "currencyFormatInfo": { - "currencyDecimalDigits": 2, - "currencyDecimalSeparator": ",", - "currencyGroupSeparator": ".", - "currencyGroupSize": 3, - "startsWithCurrencySymbol": true - } - }, - "giftRegistryData": null, - "openTextField": null, - "invoiceData": null, - "customData": null, - "itemMetadata": { - "items": [ - { - "id": "1", - "seller": "1", - "name": "Ração Royal Canin Feline Urinary 500g", - "skuName": "Ração Royal Canin Feline Urinary 500g", - "productId": "1", - "refId": "0001", - "ean": "123456789", - "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000", - "detailUrl": "/racao-royal-canin-feline-urinary/p", - "assemblyOptions": [] - } - ] - }, - "hooksData": null, - "ratesAndBenefitsData": { - "rateAndBenefitsIdentifiers": [], - "teaser": [] - }, - "subscriptionData": null, - "itemsOrdination": null - } - } - } - } - }, - "deprecated": false - } - }, - "/api/checkout/pub/orderForm/{orderFormId}/items/{itemIndex}/price": { - "put": { - "tags": [ - "Shopping cart" - ], - "summary": "Change price", - "description": "This request changes the price of an SKU in a cart. You can also perform type of bulk price change with the [Update cart items request](https://developers.vtex.com/vtex-rest-api/reference/shopping-cart#itemsupdate)\r\n\r\nThe [orderForm](https://developers.vtex.com/vtex-rest-api/reference/checkout-api-overview) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\rYou need to inform which cart you are referring to, by sending its `orderFormId`; and what is the item whose price you want to change, by sending its `itemIndex`.\n\r\n\rYou also need to pass the new price value in the body.\n\r\n\rRemember that, to use this endpoint, the feature of *manual price* must be active. To check if it's active, use the [Get orderForm configuration](https://developers.vtex.com/reference#getorderformconfiguration) endpoint. To make it active, use the [Update orderForm configuration](https://developers.vtex.com/reference#updateorderformconfiguration) endpoint, making the `allowManualPrice` field `true`.\n\r\n\r> Whenever you use this request to change the price of an item, all items in that cart with the same SKU are affected by this change. This applies even to items that share the SKU but have been separated into different objects in the `items` array due to customizations or attachments, for example.", - "operationId": "PriceChange", - "parameters": [ - { - "name": "orderFormId", - "in": "path", - "description": "ID of the orderForm corresponding to the cart whose items will have the price changed.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "ede846222cd44046ba6c638442c3505a" - } - }, - { - "name": "itemIndex", - "in": "path", - "description": "The index of the item in the cart. Each cart item is identified by an index, starting in 0.", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PriceChangeRequest" - }, - "example": { - "price": 10000 - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "orderFormId": "ede846222cd44046ba6c638442c3505a", - "salesChannel": "1", - "loggedIn": true, - "isCheckedIn": false, - "storeId": null, - "checkedInPickupPointId": null, - "allowManualPrice": true, - "canEditData": true, - "userProfileId": null, - "userType": null, - "ignoreProfileData": false, - "value": 10000, - "messages": [], - "items": [ - { - "uniqueId": "E0F2B7AF5CD74D668F1E27537206912C", - "id": "1", - "productId": "1", - "productRefId": "", - "refId": "0001", - "ean": "123456789", - "name": "Ração Royal Canin Feline Urinary 500g", - "skuName": "Ração Royal Canin Feline Urinary 500g", - "modalType": null, - "parentItemIndex": null, - "parentAssemblyBinding": null, - "assemblies": [], - "priceValidUntil": "2021-02-27T14:59:00.8288784Z", - "tax": 0, - "price": 15000, - "listPrice": 30000, - "manualPrice": 10000, - "sellingPrice": 10000, - "rewardValue": 0, - "isGift": false, - "additionalInfo": { - "brandName": "Royal Canin", - "brandId": "2000000", - "offeringInfo": null, - "offeringType": null, - "offeringTypeId": null - }, - "preSaleDate": null, - "productCategoryIds": "/1/10/", - "productCategories": { - "10": "Ração Seca", - "1": "Alimentação" - }, - "quantity": 1, - "seller": "1", - "sellerChain": [ - "1" - ], - "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000", - "detailUrl": "/racao-royal-canin-feline-urinary/p", - "components": [], - "bundleItems": [], - "attachments": [], - "attachmentOfferings": [], - "offerings": [], - "priceTags": [ - { - "name": "DISCOUNT@MANUALPRICE", - "value": -5000, - "rawValue": -50.0, - "isPercentual": false, - "identifier": null - } - ], - "availability": "available", - "measurementUnit": "un", - "unitMultiplier": 1.0, - "manufacturerCode": null - } - ], - "selectableGifts": [], - "totalizers": [ - { - "id": "Items", - "name": "Total dos Itens", - "value": 15000 - }, - { - "id": "Discounts", - "name": "Total dos Descontos", - "value": -5000 - } - ], - "shippingData": { - "address": null, - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": null, - "selectedDeliveryChannel": "delivery", - "addressId": null, - "slas": [], - "shipsTo": [ - "BRA" - ], - "itemId": "1", - "deliveryChannels": [ - { - "id": "pickup-in-point" - }, - { - "id": "delivery" - } - ] - } - ], - "selectedAddresses": [], - "availableAddresses": [], - "pickupPoints": [] - }, - "clientProfileData": null, - "paymentData": { - "installmentOptions": [ - { - "paymentSystem": "2", - "bin": null, - "paymentName": null, - "paymentGroupName": null, - "value": 10000, - "installments": [ - { - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 10000, - "total": 10000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 10000, - "total": 10000 - } - ] - }, - { - "count": 2, - "hasInterestRate": false, - "interestRate": 0, - "value": 5000, - "total": 10000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 2, - "hasInterestRate": false, - "interestRate": 0, - "value": 5000, - "total": 10000 - } - ] - } - ] - } - ], - "paymentSystems": [ - { - "id": 2, - "name": "Visa", - "groupName": "creditCardPaymentGroup", - "validator": { - "regex": "^4[0-9]{15}$", - "mask": "9999 9999 9999 9999", - "cardCodeRegex": "^[0-9]{3}$", - "cardCodeMask": "999", - "weights": [ - 2, - 1, - 2, - 1, - 2 - ], - "useCvv": true, - "useExpirationDate": true, - "useCardHolderName": true, - "useBillingAddress": true - }, - "stringId": "2", - "template": "creditCardPaymentGroup-template", - "requiresDocument": false, - "isCustom": false, - "description": null, - "requiresAuthentication": false, - "dueDate": "2020-03-05T16:42:31.7836281Z", - "availablePayments": null - } - ], - "payments": [], - "giftCards": [], - "giftCardMessages": [], - "availableAccounts": [], - "availableTokens": [] - }, - "marketingData": null, - "sellers": [ - { - "id": "1", - "name": "lojadobreno", - "logo": "" - } - ], - "clientPreferencesData": { - "locale": "pt-BR", - "optinNewsLetter": null - }, - "commercialConditionData": null, - "storePreferencesData": { - "countryCode": "BRA", - "saveUserData": true, - "timeZone": "E. South America Standard Time", - "currencyCode": "BRL", - "currencyLocale": 1046, - "currencySymbol": "R$", - "currencyFormatInfo": { - "currencyDecimalDigits": 2, - "currencyDecimalSeparator": ",", - "currencyGroupSeparator": ".", - "currencyGroupSize": 3, - "startsWithCurrencySymbol": true - } - }, - "giftRegistryData": null, - "openTextField": null, - "invoiceData": null, - "customData": null, - "itemMetadata": { - "items": [ - { - "id": "1", - "seller": "1", - "name": "Ração Royal Canin Feline Urinary 500g", - "skuName": "Ração Royal Canin Feline Urinary 500g", - "productId": "1", - "refId": "0001", - "ean": "123456789", - "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000", - "detailUrl": "/racao-royal-canin-feline-urinary/p", - "assemblyOptions": [] - } - ] - }, - "hooksData": null, - "ratesAndBenefitsData": { - "rateAndBenefitsIdentifiers": [], - "teaser": [] - }, - "subscriptionData": null, - "itemsOrdination": null - } - } - } - } - }, - "deprecated": false - } - }, - "/api/checkout/pub/orderForm/{orderFormId}/profile": { - "patch": { - "tags": [ - "Shopping cart" - ], - "summary": "Ignore profile data", - "description": "When a shopper provides an email address at Checkout, the platform tries to retrieve existing profile information for that email and add it to the shopping cart information. Use this request if you want to change this behavior for a given cart, meaning profile information will not be included in the order automattically.\r\n\r\nThe [orderForm](https://developers.vtex.com/vtex-rest-api/reference/checkout-api-overview) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\r\n\r\nNote that this request will only work if you have not sent the `clientProfileData` to the cart yet. Sending it to a cart that already has a `clientProfileData` should return a status `403 Forbidden` error, with an `Access denied` message.", - "operationId": "IgnoreProfileData", - "parameters": [ - { - "name": "orderFormId", - "in": "path", - "description": "ID of the orderForm corresponding to the cart whose items will have the price changed.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "ede846222cd44046ba6c638442c3505a" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "ignoreProfileData": { - "type": "boolean", - "description": "Indicates whether profile data should be ignored.", - "default": false - } - } - }, - "example": { - "price": 10000 - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "application/json": { - "example": { - "orderFormId": "68b287ae65534704b1a1e42e47c82abc", - "salesChannel": "1", - "loggedIn": true, - "isCheckedIn": false, - "storeId": null, - "checkedInPickupPointId": null, - "allowManualPrice": false, - "canEditData": true, - "userProfileId": null, - "userType": null, - "ignoreProfileData": true, - "value": 0, - "messages": [], - "items": [], - "selectableGifts": [], - "totalizers": [], - "shippingData": null, - "clientProfileData": { - "email": null, - "firstName": null, - "lastName": null, - "document": null, - "documentType": null, - "phone": null, - "corporateName": null, - "tradeName": null, - "corporateDocument": null, - "stateInscription": null, - "corporatePhone": null, - "isCorporate": false, - "profileCompleteOnLoading": null, - "profileErrorOnLoading": null, - "customerClass": null - }, - "paymentData": { - "updateStatus": "updated", - "installmentOptions": [], - "paymentSystems": [], - "payments": [], - "giftCards": [], - "giftCardMessages": [], - "availableAccounts": [], - "availableTokens": [] - }, - "marketingData": null, - "sellers": [], - "clientPreferencesData": { - "locale": "pt-BR", - "optinNewsLetter": null - }, - "commercialConditionData": null, - "storePreferencesData": { - "countryCode": "BRA", - "saveUserData": true, - "timeZone": "E. South America Standard Time", - "currencyCode": "BRL", - "currencyLocale": 1046, - "currencySymbol": "R$", - "currencyFormatInfo": { - "currencyDecimalDigits": 2, - "currencyDecimalSeparator": ",", - "currencyGroupSeparator": ".", - "currencyGroupSize": 3, - "startsWithCurrencySymbol": true - } - }, - "giftRegistryData": null, - "openTextField": null, - "invoiceData": null, - "customData": null, - "itemMetadata": null, - "hooksData": null, - "ratesAndBenefitsData": null, - "subscriptionData": null, - "itemsOrdination": null - } - } - } - } - }, - "deprecated": false - } - }, - "/api/checkout/pub/profiles": { - "get": { - "tags": [ - "Cart attachments" - ], - "summary": "Get client profile by email", - "description": "Retrieve a client's profile information by providing an email address.\n\r\n\rIf the response fields are empty, it means that there is no client registered with that email address in your store.", - "operationId": "GetClientProfileByEmail", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "email", - "in": "query", - "description": "Client's email address to be searched.", - "required": true, - "style": "form", - "schema": { - "type": "string", - "default": "clark.kent@examplemail.com" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "userProfileId": { - "type": "string", - "description": "Unique ID associated with the customer profile." - }, - "profileProvider": { - "type": "string", - "description": "Profile provider." - }, - "availableAccounts": { - "type": "array", - "description": "Available accounts.", - "items": { - "type": "string" - } - }, - "availableAddresses": { - "type": "array", - "description": "Information on each available address.", - "items": { - "type": "object", - "properties": { - "addressType": { - "type": "string", - "description": "Address type." - }, - "receiverName": { - "type": "string", - "description": "Name of the receiver." - }, - "addressId": { - "type": "string", - "description": "Address ID." - }, - "isDisposable": { - "type": "boolean", - "description": "Indicates whether address is disposable." - }, - "city": { - "type": "string", - "description": "City of the address." - }, - "state": { - "type": "string", - "description": "State of the address." - }, - "country": { - "type": "string", - "description": "Country of the address. ISO three-letter code." - }, - "street": { - "type": "string", - "description": "Street of the address." - }, - "number": { - "type": "string", - "description": "Number of the address." - }, - "neighborhood": { - "type": "string", - "description": "Neighborhood of the address." - }, - "complement": { - "type": "string", - "description": "Complement to the address.", - "nullable": true - }, - "reference": { - "type": "string", - "description": "Reference that may help in the location of the address.", - "nullable": true - }, - "geoCoordinates": { - "type": "array", - "description": "List with the two geocoordinates.", - "items": { - "type": "string" - } - } - } - } - }, - "userProfile": { - "type": "object", - "description": "Customer profile information.", - "properties": { - "email": { - "type": "string", - "description": "Email address." - }, - "firstName": { - "type": "string", - "description": "First name." - }, - "lastName": { - "type": "string", - "description": "Last name." - }, - "document": { - "type": "string", - "description": "Document." - }, - "documentType": { - "type": "string", - "description": "Document type." - }, - "phone": { - "type": "string", - "description": "Telephone number." - }, - "corporateName": { - "type": "string", - "description": "Name of the company. Used for corporate clients.", - "nullable": true - }, - "tradeName": { - "type": "string", - "description": "Trade name. Used for corporate clients.", - "nullable": true - }, - "corporateDocument": { - "type": "string", - "description": "Document. Used for corporate clients.", - "nullable": true - }, - "stateInscription": { - "type": "string", - "description": "State inscription. Used for corporate clients.", - "nullable": true - }, - "corporatePhone": { - "type": "string", - "description": "Telephone number. Used for corporate clients.", - "nullable": true - }, - "isCorporate": { - "type": "boolean", - "description": "Indicates whether client is corporate.", - "default": false - }, - "profileCompleteOnLoading": { - "type": "string", - "description": "Profile complete when loading.", - "nullable": true - }, - "profileErrorOnLoading": { - "type": "string", - "description": "Profile error when loading.", - "nullable": true - }, - "customerClass": { - "type": "string", - "description": "Customer class.", - "nullable": true - } - } - }, - "isComplete": { - "type": "boolean", - "description": "Indicates whether customer profile is complete." - } - } - }, - "example": { - "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94", - "profileProvider": "VTEX", - "availableAccounts": [], - "availableAddresses": [ - { - "addressType": "residential", - "receiverName": "Clark Kent", - "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2", - "isDisposable": false, - "postalCode": "12345-000", - "city": "Metropolis", - "state": "NY", - "country": "USA", - "street": "My street", - "number": "123", - "neighborhood": "My neighborhood", - "complement": null, - "reference": null, - "geoCoordinates": [ - "-27.924747499991016", - "-11.832599973754883" - ] - } - ], - "userProfile": { - "email": "clark.kent@example.com", - "firstName": "Clark", - "lastName": "Kent", - "document": "12345678900", - "documentType": "cpf", - "phone": "+556199999999", - "corporateName": null, - "tradeName": null, - "corporateDocument": null, - "stateInscription": null, - "corporatePhone": null, - "isCorporate": false, - "profileCompleteOnLoading": null, - "profileErrorOnLoading": null, - "customerClass": null - }, - "isComplete": true - } - } - } - } - }, - "deprecated": false - } - }, - "/api/checkout/pub/orderForm/{orderFormId}/attachments/clientProfileData": { - "post": { - "tags": [ - "Cart attachments" - ], - "summary": "Add client profile", - "description": "Use this request to include client profile information to a given shopping cart.\r\n\r\nThe [orderForm](https://developers.vtex.com/vtex-rest-api/reference/checkout-api-overview) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\r> This request has a time out of 12 seconds.", - "operationId": "AddClientProfile", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "orderFormId", - "in": "path", - "description": "ID of the orderForm that will receive client profile information.", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Customer's profile information.", - "required": [ - "email", - "firstName", - "lastName", - "documentType", - "document" - ], - "properties": { - "email": { - "type": "string", - "description": "Customer's email address.", - "default": "customer@examplemail.com" - }, - "firstName": { - "type": "string", - "description": "Customer's first name.", - "default": "first-name" - }, - "lastName": { - "type": "string", - "description": "Customer's last name.", - "default": "last-name" - }, - "documentType": { - "type": "string", - "description": "Type of the document informed by the customer.", - "default": "cpf" - }, - "document": { - "type": "string", - "description": "Document number informed by the customer.", - "default": "123456789" - }, - "phone": { - "type": "string", - "description": "Customer's phone number.", - "default": "+55110988887777" - }, - "corporateName": { - "type": "string", - "description": "Company name, if the customer is a legal entity.", - "default": "company-name" - }, - "tradeName": { - "type": "string", - "description": "Trade name, if the customer is a legal entity.", - "default": "trade-name" - }, - "corporateDocument": { - "type": "string", - "description": "Corporate document, if the customer is a legal entity.", - "default": "12345678000100" - }, - "stateInscription": { - "type": "string", - "description": "State inscription, if the customer is a legal entity.", - "default": "12345678" - }, - "corporatePhone": { - "type": "string", - "description": "Corporate phone number, if the customer is a legal entity.", - "default": "+551100988887777" - }, - "isCorporate": { - "type": "boolean", - "description": "`true` if the customer is a legal entity.", - "default": false - } - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "headers": {}, - "content": { - "application/json": { - "example": { - "orderFormId": "9ceee0fde6db489fbc809a0e2ab13a86", - "salesChannel": "1", - "loggedIn": false, - "isCheckedIn": false, - "storeId": null, - "checkedInPickupPointId": null, - "allowManualPrice": false, - "canEditData": true, - "userProfileId": null, - "userType": null, - "ignoreProfileData": false, - "value": 0, - "messages": [], - "items": [], - "selectableGifts": [], - "totalizers": [], - "shippingData": null, - "clientProfileData": { - "email": "clark.kent@examplemail.com", - "firstName": "Clark", - "lastName": "Kent", - "document": "44444444444", - "documentType": "cpf", - "phone": "+5511123456789", - "corporateName": null, - "tradeName": null, - "corporateDocument": null, - "stateInscription": null, - "corporatePhone": null, - "isCorporate": false, - "profileCompleteOnLoading": false, - "profileErrorOnLoading": false, - "customerClass": null - }, - "paymentData": { - "updateStatus": "updated", - "installmentOptions": [], - "paymentSystems": [], - "payments": [], - "giftCards": [], - "giftCardMessages": [], - "availableAccounts": [], - "availableTokens": [] - }, - "marketingData": null, - "sellers": [], - "clientPreferencesData": { - "locale": "pt-BR", - "optinNewsLetter": null - }, - "commercialConditionData": null, - "storePreferencesData": { - "countryCode": "BRA", - "saveUserData": true, - "timeZone": "E. South America Standard Time", - "currencyCode": "BRL", - "currencyLocale": 1046, - "currencySymbol": "R$", - "currencyFormatInfo": { - "currencyDecimalDigits": 2, - "currencyDecimalSeparator": ",", - "currencyGroupSeparator": ".", - "currencyGroupSize": 3, - "startsWithCurrencySymbol": true - } - }, - "giftRegistryData": null, - "openTextField": null, - "invoiceData": null, - "customData": null, - "itemMetadata": null, - "hooksData": null, - "ratesAndBenefitsData": null, - "subscriptionData": null, - "itemsOrdination": null - } - } - } - } - }, - "deprecated": false - } - }, - "/api/checkout/pub/orderForm/{orderFormId}/attachments/shippingData": { - "post": { - "tags": [ - "Cart attachments" - ], - "summary": "Add shipping address and select delivery option", - "description": "Use this request to include shipping information and/or selected delivery option to a given shopping cart.\r\n\r\nTo add shipping addresses send the `selectedAddresses` array. For delivery option use the `logisticsInfo` array.\r\n\r\nThe [orderForm](https://developers.vtex.com/vtex-rest-api/reference/checkout-api-overview) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\r> This request has a time out of 12 seconds.", - "operationId": "AddShippingAddress", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "orderFormId", - "in": "path", - "description": "ID of the orderForm that will receive client profile information.", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "selectedAddresses": { - "type": "array", - "description": "List of objects with addresses information.", - "items": { - "type": "object", - "properties": { - "addressType": { - "type": "string", - "description": "Type of address. For example, `Residential` or `Pickup`, among others.", - "example": "residential" - }, - "receiverName": { - "type": "string", - "description": "Name of the person who is going to receive the order.", - "example": "receiver-name" - }, - "postalCode": { - "type": "string", - "description": "Postal Code.", - "example": "12345-000" - }, - "city": { - "type": "string", - "description": "City of the shipping address.", - "example": "Rio de Janeiro" - }, - "state": { - "type": "string", - "description": "State of the shipping address.", - "example": "RJ" - }, - "country": { - "type": "string", - "description": "Three letter ISO code of the country of the shipping address.", - "example": "BRA" - }, - "street": { - "type": "string", - "description": "Street of the shipping address.", - "example": "Praia de Botafogo" - }, - "number": { - "type": "string", - "description": "Number of the building, house or apartment in the shipping address.", - "example": "300" - }, - "neighborhood": { - "type": "string", - "description": "Neighborhood of the shipping address.", - "example": "Botafogo" - }, - "complement": { - "type": "string", - "description": "Complement to the shipping address in case it applies.", - "example": "3rd floor" - }, - "reference": { - "type": "string", - "description": "Complement that might help locate the shipping address more precisely in case of delivery.", - "example": "Grey building" - }, - "geoCoordinates": { - "type": "array", - "description": "Array with two strings with geocoordinates, first latitude, then longitude.", - "items": { - "type": "string", - "example": "00.00000" - } - } - } - } - }, - "logisticsInfo": { - "type": "array", - "description": "Array with logistics information on each item of the `items` array in the `orderForm`.", - "items": { - "type": "object", - "properties": { - "itemIndex": { - "type": "integer", - "description": "Index of item in items array", - "default": 0 - }, - "selectedDeliveryChannel": { - "type": "string", - "description": "Delivery channel selected by the customer. For example, `\"delivery\"` or `\"pickup-in-point\"`.", - "default": "delivery" - }, - "selectedSla": { - "type": "string", - "description": "Selected SLA. For example, `\"normal\"` or `\"express\"`.", - "default": "normal" - } - } - } - } - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "application/json": { - "example": { - "orderFormId": "2f586e50342a4f87b7e0654c56299e88", - "salesChannel": "1", - "loggedIn": false, - "isCheckedIn": false, - "storeId": null, - "checkedInPickupPointId": null, - "allowManualPrice": false, - "canEditData": true, - "userProfileId": null, - "userType": null, - "ignoreProfileData": false, - "value": 0, - "messages": [], - "items": [], - "selectableGifts": [], - "totalizers": [], - "shippingData": { - "address": { - "addressType": "residential", - "receiverName": "Clark Kent", - "addressId": "c3701fc4c61b4d1b91f67e81415db44d", - "isDisposable": true, - "postalCode": "12345000", - "city": "Rio de Janeiro", - "state": "ST", - "country": "BRA", - "street": "My street", - "number": "1091", - "neighborhood": "My neighborhood", - "complement": null, - "reference": null, - "geoCoordinates": [] - }, - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": null, - "selectedDeliveryChannel": null, - "addressId": "f239ad30f8c948a382543ab2c739b967", - "slas": [ - { - "id": "Retirada (VTEXSP)", - "deliveryChannel": "pickup-in-point", - "name": "Retirada (VTEXSP)", - "deliveryIds": [ - { - "courierId": "1ee17c2", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "Retira em Loja", - "quantity": 2, - "kitItemDetails": [] - } - ], - "shippingEstimate": "3bd", - "shippingEstimateDate": null, - "lockTTL": null, - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 250, - "listPrice": 250, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": true, - "friendlyName": "VTEX SP", - "address": { - "addressType": "pickup", - "receiverName": null, - "addressId": "VTEXSP", - "isDisposable": true, - "postalCode": "04538-132", - "city": "São Paulo", - "state": "SP", - "country": "BRA", - "street": "Avenida Brigadeiro Faria Lima", - "number": "4440", - "neighborhood": "Itaim Bibi", - "complement": "", - "reference": null, - "geoCoordinates": [ - -46.68072, - -23.59525 - ] - }, - "additionalInfo": "", - "dockId": "1" - }, - "pickupPointId": "1_VTEXSP", - "pickupDistance": 15.848081588745117, - "polygonName": null, - "transitTime": "3bd" - } - ], - "shipsTo": [ - "BRA", - "COL", - "USA" - ], - "itemId": "2", - "deliveryChannels": [ - { - "id": "pickup-in-point" - }, - { - "id": "delivery" - } - ] - } - ], - "selectedAddresses": [ - { - "addressType": "residential", - "receiverName": "Clark Kent", - "addressId": "c3701fc4c61b4d1b91f67e81415db44d", - "isDisposable": true, - "postalCode": "12345000", - "city": "Rio de Janeiro", - "state": "ST", - "country": "BRA", - "street": "My street", - "number": "1091", - "neighborhood": "My neighborhood", - "complement": null, - "reference": null, - "geoCoordinates": [] - } - ], - "availableAddresses": [ - { - "addressType": "residential", - "receiverName": "Clark Kent", - "addressId": "ae3173b32bf64663a81fc42b057be211", - "isDisposable": true, - "postalCode": "70386060", - "city": "Brasília", - "state": "DF", - "country": "BRA", - "street": "Quadra SQS 116 Bloco F", - "number": "101", - "neighborhood": "Asa Sul", - "complement": null, - "reference": null, - "geoCoordinates": [ - -47.925922393798828, - -15.832707405090332 - ] - }, - { - "addressType": "residential", - "receiverName": "Clark Kent", - "addressId": "449dcbe11c5844098fb4545a49cf6e07", - "isDisposable": true, - "postalCode": "00076555", - "city": "Brasília", - "state": "DF", - "country": "BRA", - "street": "My street", - "number": "101", - "neighborhood": "Asa sul", - "complement": null, - "reference": null, - "geoCoordinates": [] - }, - { - "addressType": "residential", - "receiverName": "Clark Kent", - "addressId": "c3701fc4c61b4d1b91f67e81415db44d", - "isDisposable": true, - "postalCode": "12345000", - "city": "Rio de Janeiro", - "state": "ST", - "country": "BRA", - "street": "My street", - "number": "1091", - "neighborhood": "My neighborhood", - "complement": null, - "reference": null, - "geoCoordinates": [] - } - ], - "pickupPoints": [] - }, - "clientProfileData": null, - "paymentData": { - "updateStatus": "updated", - "installmentOptions": [], - "paymentSystems": [], - "payments": [], - "giftCards": [], - "giftCardMessages": [], - "availableAccounts": [], - "availableTokens": [] - }, - "marketingData": null, - "sellers": [], - "clientPreferencesData": { - "locale": "pt-BR", - "optinNewsLetter": null - }, - "commercialConditionData": null, - "storePreferencesData": { - "countryCode": "BRA", - "saveUserData": true, - "timeZone": "E. South America Standard Time", - "currencyCode": "BRL", - "currencyLocale": 1046, - "currencySymbol": "R$", - "currencyFormatInfo": { - "currencyDecimalDigits": 2, - "currencyDecimalSeparator": ",", - "currencyGroupSeparator": ".", - "currencyGroupSize": 3, - "startsWithCurrencySymbol": true - } - }, - "giftRegistryData": null, - "openTextField": null, - "invoiceData": null, - "customData": null, - "itemMetadata": null, - "hooksData": null, - "ratesAndBenefitsData": null, - "subscriptionData": null, - "itemsOrdination": null - } - } - } - } - }, - "deprecated": false - } - }, - "/api/checkout/pub/orderForm/{orderFormId}/attachments/clientPreferencesData": { - "post": { - "tags": [ - "Cart attachments" - ], - "summary": "Add client prefences", - "description": "Use this request to include client preferences information to a given shopping cart.\r\n\r\nThe [orderForm](https://developers.vtex.com/vtex-rest-api/reference/checkout-api-overview) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\r> This request has a time out of 12 seconds.", - "operationId": "AddClientPreferences", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "orderFormId", - "in": "path", - "description": "ID of the orderForm that will receive client profile information.", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "locale": { - "type": "string", - "description": "Locale chosen by the shopper. Determines website language.", - "default": "EN" - }, - "optinNewsLetter": { - "type": "boolean", - "description": "Indicates whether the shopper opted in to receive the store's news letter.", - "default": false - } - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {}, - "example": { - "orderFormId": "a7e4702410864239959f9bdcf77e3fba", - "salesChannel": "1", - "loggedIn": false, - "isCheckedIn": false, - "storeId": null, - "checkedInPickupPointId": null, - "allowManualPrice": false, - "canEditData": true, - "userProfileId": null, - "userType": null, - "ignoreProfileData": false, - "value": 0, - "messages": [], - "items": [], - "selectableGifts": [], - "totalizers": [], - "shippingData": null, - "clientProfileData": null, - "paymentData": { - "updateStatus": "updated", - "installmentOptions": [], - "paymentSystems": [], - "payments": [], - "giftCards": [], - "giftCardMessages": [], - "availableAccounts": [], - "availableTokens": [] - }, - "marketingData": null, - "sellers": [], - "clientPreferencesData": { - "locale": "PT", - "optinNewsLetter": false - }, - "commercialConditionData": null, - "storePreferencesData": { - "countryCode": "BRA", - "saveUserData": true, - "timeZone": "E. South America Standard Time", - "currencyCode": "BRL", - "currencyLocale": 1046, - "currencySymbol": "R$", - "currencyFormatInfo": { - "currencyDecimalDigits": 2, - "currencyDecimalSeparator": ",", - "currencyGroupSeparator": ".", - "currencyGroupSize": 3, - "startsWithCurrencySymbol": true - } - }, - "giftRegistryData": null, - "openTextField": null, - "invoiceData": null, - "customData": null, - "itemMetadata": null, - "hooksData": null, - "ratesAndBenefitsData": null, - "subscriptionData": null, - "itemsOrdination": null - } - } - } - } - }, - "deprecated": false - } - }, - "/api/checkout/pub/orderForm/{orderFormId}/attachments/marketingData": { - "post": { - "tags": [ - "Cart attachments" - ], - "summary": "Add marketing data", - "description": "Use this request to include marketing information to a given shopping cart.\r\n\r\nThe [orderForm](https://developers.vtex.com/vtex-rest-api/reference/checkout-api-overview) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\r> This request has a time out of 12 seconds.", - "operationId": "AddMarketingData", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "orderFormId", - "in": "path", - "description": "ID of the orderForm that will receive client profile information.", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "coupon": { - "type": "string", - "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.", - "default": "free-shipping" - }, - "marketingTags": { - "type": "array", - "description": "Marketing tags.", - "items": { - "type": "string" - }, - "default": [ - "tag1", - "tag2" - ] - }, - "utmSource": { - "type": "string", - "description": "UTM source.", - "default": "Facebook" - }, - "utmMedium": { - "type": "string", - "description": "UTM medium.", - "default": "CPC" - }, - "utmCampaign": { - "type": "string", - "description": "UTM campaign", - "default": "Black friday" - }, - "utmiPage": { - "type": "string", - "description": "utmi_page (internal utm)", - "default": "utmi_page-example" - }, - "utmiPart": { - "type": "string", - "description": "utmi_part (internal utm)", - "default": "utmi_part-exmaple" - }, - "utmiCampaign": { - "type": "string", - "description": "utmi_campaign (internal utm)", - "default": "utmi_campaign-exmaple" - } - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "orderFormId": "7c5b47971fad41b89102c7ab7bb8b08b", - "salesChannel": "1", - "loggedIn": false, - "isCheckedIn": false, - "storeId": null, - "checkedInPickupPointId": null, - "allowManualPrice": false, - "canEditData": true, - "userProfileId": null, - "userType": null, - "ignoreProfileData": false, - "value": 0, - "messages": [], - "items": [], - "selectableGifts": [], - "totalizers": [], - "shippingData": null, - "clientProfileData": null, - "paymentData": { - "updateStatus": "updated", - "installmentOptions": [], - "paymentSystems": [], - "payments": [], - "giftCards": [], - "giftCardMessages": [], - "availableAccounts": [], - "availableTokens": [] - }, - "marketingData": { - "utmSource": "app", - "utmMedium": "CPC", - "utmCampaign": "Black friday", - "utmipage": null, - "utmiPart": null, - "utmiCampaign": null, - "coupon": "free-shipping", - "marketingTags": [ - "tag1", - "tag2" - ] - }, - "sellers": [], - "clientPreferencesData": { - "locale": "pt-BR", - "optinNewsLetter": null - }, - "commercialConditionData": null, - "storePreferencesData": { - "countryCode": "BRA", - "saveUserData": true, - "timeZone": "E. South America Standard Time", - "currencyCode": "BRL", - "currencyLocale": 1046, - "currencySymbol": "R$", - "currencyFormatInfo": { - "currencyDecimalDigits": 2, - "currencyDecimalSeparator": ",", - "currencyGroupSeparator": ".", - "currencyGroupSize": 3, - "startsWithCurrencySymbol": true - } - }, - "giftRegistryData": null, - "openTextField": null, - "invoiceData": null, - "customData": null, - "itemMetadata": null, - "hooksData": null, - "ratesAndBenefitsData": null, - "subscriptionData": null, - "itemsOrdination": null - } - } - } - } - }, - "deprecated": false - } - }, - "/api/checkout/pub/orderForm/{orderFormId}/attachments/paymentData": { - "post": { - "tags": [ - "Cart attachments" - ], - "summary": "Add payment data", - "description": "Use this request to include payment information to a given shopping cart. The payment information attachment in the shopping cart does not determine the final order payment method in itself. However, it allows tha platform to update any relevant information that may be impacted by the payment method.\r\n\r\nThe [orderForm](https://developers.vtex.com/vtex-rest-api/reference/checkout-api-overview) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\r> This request has a time out of 12 seconds.", - "operationId": "AddPaymentData", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "orderFormId", - "in": "path", - "description": "ID of the orderForm that will receive client profile information.", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "payments": { - "type": "array", - "description": "Array with information on each payment chosen by the shopper.", - "items": { - "type": "object", - "properties": { - "paymentSysytem": { - "type": "integer", - "description": "Payment system ID.", - "default": 1 - }, - "paymentSystemName": { - "type": "string", - "description": "Payment system name.", - "default": "Boleto Bancário" - }, - "group": { - "type": "string", - "description": "Payment system group.", - "default": "bankInvoicePaymentGroup" - }, - "installments": { - "type": "integer", - "description": "Selected number of installments.", - "default": 1 - }, - "installmentsInterestRate": { - "type": "number", - "description": "Installments' interest rate.", - "default": 0 - }, - "installmentsValue": { - "type": "integer", - "description": "Value of the installments.", - "default": 1 - }, - "value": { - "type": "integer", - "description": "Total value assigned to this payment.", - "default": 100 - }, - "referenceValue": { - "type": "integer", - "description": "Reference value used to calculate total order value with interest.", - "default": 100 - }, - "hasDefaultBillingAddress": { - "type": "boolean", - "description": "Indicates whether billing address for this payment is the default address.", - "default": false - } - } - } - } - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "application/json": { - "example": { - "orderFormId": "29154e27383145cc8ce1f7a1df0d99c4", - "salesChannel": "1", - "loggedIn": false, - "isCheckedIn": false, - "storeId": null, - "checkedInPickupPointId": null, - "allowManualPrice": false, - "canEditData": true, - "userProfileId": null, - "userType": null, - "ignoreProfileData": false, - "value": 65780, - "messages": [], - "items": [ - { - "uniqueId": "3CBFA140CE8F4E208062FC15CE9ED8D3", - "id": "2", - "productId": "2", - "productRefId": "", - "refId": "CBC30L", - "ean": null, - "name": "Chopp Claro 30L", - "skuName": "Chopp Claro 30L", - "modalType": null, - "parentItemIndex": null, - "parentAssemblyBinding": null, - "assemblies": [], - "priceValidUntil": "2022-07-28T22:25:25Z", - "tax": 0, - "price": 32890, - "listPrice": 49900, - "manualPrice": null, - "manualPriceAppliedBy": null, - "sellingPrice": 32890, - "rewardValue": 0, - "isGift": false, - "additionalInfo": { - "dimension": null, - "brandName": "Beershow", - "brandId": "2000000", - "offeringInfo": null, - "offeringType": null, - "offeringTypeId": null - }, - "preSaleDate": null, - "productCategoryIds": "/1/", - "productCategories": { - "1": "Bebidas" - }, - "quantity": 2, - "seller": "1", - "sellerChain": [ - "1" - ], - "imageUrl": "http://myshop.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000", - "detailUrl": "/chopp-claro-30l/p", - "components": [], - "bundleItems": [], - "attachments": [], - "attachmentOfferings": [], - "offerings": [], - "priceTags": [], - "availability": "available", - "measurementUnit": "un", - "unitMultiplier": 1.0, - "manufacturerCode": null, - "priceDefinition": { - "calculatedSellingPrice": 32890, - "total": 65780, - "sellingPrices": [ - { - "value": 32890, - "quantity": 2 - } - ] - } - } - ], - "selectableGifts": [], - "totalizers": [ - { - "id": "Items", - "name": "Total dos Itens", - "value": 65780 - } - ], - "shippingData": { - "address": null, - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": null, - "selectedDeliveryChannel": null, - "addressId": null, - "slas": [], - "shipsTo": [ - "BRA", - "COL", - "USA" - ], - "itemId": "2", - "deliveryChannels": [ - { - "id": "delivery" - }, - { - "id": "pickup-in-point" - } - ] - } - ], - "selectedAddresses": [], - "availableAddresses": [], - "pickupPoints": [] - }, - "clientProfileData": null, - "paymentData": { - "updateStatus": "updated", - "installmentOptions": [ - { - "paymentSystem": "2", - "bin": null, - "paymentName": null, - "paymentGroupName": null, - "value": 65780, - "installments": [ - { - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 65780, - "total": 65780, - "sellerMerchantInstallments": [ - { - "id": "MYSHOP", - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 65780, - "total": 65780 - } - ] - } - ] - }, - { - "paymentSystem": "4", - "bin": null, - "paymentName": null, - "paymentGroupName": null, - "value": 65780, - "installments": [ - { - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 65780, - "total": 65780, - "sellerMerchantInstallments": [ - { - "id": "MYSHOP", - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 65780, - "total": 65780 - } - ] - } - ] - }, - { - "paymentSystem": "6", - "bin": null, - "paymentName": null, - "paymentGroupName": null, - "value": 65780, - "installments": [ - { - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 65780, - "total": 65780, - "sellerMerchantInstallments": [ - { - "id": "MYSHOP", - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 65780, - "total": 65780 - } - ] - } - ] - } - ], - "paymentSystems": [ - { - "id": 2, - "name": "Visa", - "groupName": "creditCardPaymentGroup", - "validator": { - "regex": "^4[0-9]{15}$", - "mask": "9999 9999 9999 9999", - "cardCodeRegex": "^[0-9]{3}$", - "cardCodeMask": "999", - "weights": [ - 2, - 1, - 2, - 1, - 2, - 1, - 2, - 1, - 2, - 1, - 2, - 1, - 2, - 1, - 2, - 1, - 2, - 1, - 2 - ], - "useCvv": true, - "useExpirationDate": true, - "useCardHolderName": true, - "useBillingAddress": true - }, - "stringId": "2", - "template": "creditCardPaymentGroup-template", - "requiresDocument": false, - "isCustom": false, - "description": null, - "requiresAuthentication": false, - "dueDate": "2021-08-04T22:19:04.9948627Z", - "availablePayments": null - }, - { - "id": 4, - "name": "Mastercard", - "groupName": "creditCardPaymentGroup", - "validator": { - "regex": "^((5(([1-2]|[4-5])[0-9]{8}|0((1|6)([0-9]{7}))|3(0(4((0|[2-9])[0-9]{5})|([0-3]|[5-9])[0-9]{6})|[1-9][0-9]{7})))|((508116)\\d{4,10})|((502121)\\d{4,10})|((589916)\\d{4,10})|(2[0-9]{15})|(67[0-9]{14})|(506387)\\d{4,10})", - "mask": "9999 9999 9999 9999", - "cardCodeRegex": "^[0-9]{3}$", - "cardCodeMask": "999", - "weights": [ - 2, - 1, - 2, - 1, - 2, - 1, - 2, - 1, - 2, - 1, - 2, - 1, - 2, - 1, - 2, - 1, - 2, - 1, - 2 - ], - "useCvv": true, - "useExpirationDate": true, - "useCardHolderName": true, - "useBillingAddress": true - }, - "stringId": "4", - "template": "creditCardPaymentGroup-template", - "requiresDocument": false, - "isCustom": false, - "description": null, - "requiresAuthentication": false, - "dueDate": "2021-08-04T22:19:04.9948627Z", - "availablePayments": null - }, - { - "id": 6, - "name": "Boleto Bancário", - "groupName": "bankInvoicePaymentGroup", - "validator": { - "regex": null, - "mask": null, - "cardCodeRegex": null, - "cardCodeMask": null, - "weights": null, - "useCvv": false, - "useExpirationDate": false, - "useCardHolderName": false, - "useBillingAddress": false - }, - "stringId": "6", - "template": "bankInvoicePaymentGroup-template", - "requiresDocument": false, - "isCustom": false, - "description": null, - "requiresAuthentication": false, - "dueDate": "2021-08-04T22:19:04.9948627Z", - "availablePayments": null - } - ], - "payments": [ - { - "paymentSystem": "6", - "bin": null, - "accountId": null, - "tokenId": null, - "installments": 1, - "referenceValue": 65780, - "value": 65780, - "merchantSellerPayments": [ - { - "id": "MYSHOP", - "installments": 1, - "referenceValue": 65780, - "value": 65780, - "interestRate": 0, - "installmentValue": 65780 - } - ] - } - ], - "giftCards": [], - "giftCardMessages": [], - "availableAccounts": [], - "availableTokens": [] - }, - "marketingData": null, - "sellers": [ - { - "id": "1", - "name": "My Seller", - "logo": "" - } - ], - "clientPreferencesData": { - "locale": "pt-BR", - "optinNewsLetter": null - }, - "commercialConditionData": null, - "storePreferencesData": { - "countryCode": "BRA", - "saveUserData": true, - "timeZone": "E. South America Standard Time", - "currencyCode": "BRL", - "currencyLocale": 1046, - "currencySymbol": "R$", - "currencyFormatInfo": { - "currencyDecimalDigits": 2, - "currencyDecimalSeparator": ",", - "currencyGroupSeparator": ".", - "currencyGroupSize": 3, - "startsWithCurrencySymbol": true - } - }, - "giftRegistryData": null, - "openTextField": null, - "invoiceData": null, - "customData": null, - "itemMetadata": { - "items": [ - { - "id": "2", - "seller": "1", - "name": "Chopp Claro 30L", - "skuName": "Chopp Claro 30L", - "productId": "2", - "refId": "CBC30L", - "ean": null, - "imageUrl": "http://myshop.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000", - "detailUrl": "/chopp-claro-30l/p", - "assemblyOptions": [] - } - ] - }, - "hooksData": null, - "ratesAndBenefitsData": { - "rateAndBenefitsIdentifiers": [], - "teaser": [] - }, - "subscriptionData": null, - "itemsOrdination": null - } - } - } - } - }, - "deprecated": false - } - }, - "/api/checkout/pub/orderForm/{orderFormId}/customData/{appId}": { - "put": { - "tags": [ - "Custom data" - ], - "summary": "Set multiple custom field values", - "description": "Your account may create `apps`, which contain custom fields, through the [Update orderForm configuration](https://developers.vtex.com/reference/configuration#updateorderformconfiguration) request. The values of these custom fields can then be updated by this request.\n\r\n\rTo do that, you need to inform the ID of the app you created with the configuration API (`appId`).\n\r\n\rIn the body of the request, for each field created in this app (`appFieldName`) you will inform a value (`appFieldValue`).\r\n\r\nThe [orderForm](https://developers.vtex.com/vtex-rest-api/reference/checkout-api-overview) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.", - "operationId": "SetMultipleCustomFieldValues", - "parameters": [ - { - "name": "orderFormId", - "in": "path", - "description": "ID of the orderForm that will receive the new custom field values.", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "appId", - "in": "path", - "description": "ID of the app created with the configuration API.", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "Here you must add the pairs of Field Name and Field Value.", - "type": "object", - "additionalProperties": true - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": {}, - "example": { - "orderFormId": "ede846222cd44046ba6c638442c3505a", - "salesChannel": "1", - "loggedIn": false, - "isCheckedIn": false, - "storeId": null, - "checkedInPickupPointId": null, - "allowManualPrice": false, - "canEditData": true, - "userProfileId": null, - "userType": null, - "ignoreProfileData": false, - "value": 10000, - "messages": [], - "items": [ - { - "uniqueId": "E0F2B7AF5CD74D668F1E27537206912C", - "id": "1", - "productId": "1", - "productRefId": "", - "refId": "0001", - "ean": "123456789", - "name": "Ração Royal Canin Feline Urinary 500g", - "skuName": "Ração Royal Canin Feline Urinary 500g", - "modalType": null, - "parentItemIndex": null, - "parentAssemblyBinding": null, - "assemblies": [], - "priceValidUntil": "2021-02-27T14:59:00.8288784Z", - "tax": 0, - "price": 15000, - "listPrice": 30000, - "manualPrice": 10000, - "sellingPrice": 10000, - "rewardValue": 0, - "isGift": false, - "additionalInfo": { - "brandName": "Royal Canin", - "brandId": "2000000", - "offeringInfo": null, - "offeringType": null, - "offeringTypeId": null - }, - "preSaleDate": null, - "productCategoryIds": "/1/10/", - "productCategories": { - "10": "Ração Seca", - "1": "Alimentação" - }, - "quantity": 1, - "seller": "1", - "sellerChain": [ - "1" - ], - "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000", - "detailUrl": "/racao-royal-canin-feline-urinary/p", - "components": [], - "bundleItems": [], - "attachments": [], - "attachmentOfferings": [], - "offerings": [], - "priceTags": [ - { - "name": "DISCOUNT@MANUALPRICE", - "value": -5000, - "rawValue": -50.0, - "isPercentual": false, - "identifier": null - } - ], - "availability": "available", - "measurementUnit": "un", - "unitMultiplier": 1.0, - "manufacturerCode": null - } - ], - "selectableGifts": [], - "totalizers": [ - { - "id": "Items", - "name": "Total dos Itens", - "value": 15000 - }, - { - "id": "Discounts", - "name": "Total dos Descontos", - "value": -5000 - } - ], - "shippingData": { - "address": null, - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": null, - "selectedDeliveryChannel": "delivery", - "addressId": null, - "slas": [], - "shipsTo": [ - "BRA" - ], - "itemId": "1", - "deliveryChannels": [ - { - "id": "pickup-in-point" - }, - { - "id": "delivery" - } - ] - } - ], - "selectedAddresses": [], - "availableAddresses": [], - "pickupPoints": [] - }, - "clientProfileData": null, - "paymentData": { - "installmentOptions": [ - { - "paymentSystem": "2", - "bin": null, - "paymentName": null, - "paymentGroupName": null, - "value": 10000, - "installments": [ - { - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 10000, - "total": 10000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 10000, - "total": 10000 - } - ] - }, - { - "count": 2, - "hasInterestRate": false, - "interestRate": 0, - "value": 5000, - "total": 10000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 2, - "hasInterestRate": false, - "interestRate": 0, - "value": 5000, - "total": 10000 - } - ] - } - ] - } - ], - "paymentSystems": [ - { - "id": 2, - "name": "Visa", - "groupName": "creditCardPaymentGroup", - "validator": { - "regex": "^4[0-9]{15}$", - "mask": "9999 9999 9999 9999", - "cardCodeRegex": "^[0-9]{3}$", - "cardCodeMask": "999", - "weights": [ - 2, - 1, - 2, - 1 - ], - "useCvv": true, - "useExpirationDate": true, - "useCardHolderName": true, - "useBillingAddress": true - }, - "stringId": "2", - "template": "creditCardPaymentGroup-template", - "requiresDocument": false, - "isCustom": false, - "description": null, - "requiresAuthentication": false, - "dueDate": "2020-03-05T16:42:31.7836281Z", - "availablePayments": null - } - ], - "payments": [], - "giftCards": [], - "giftCardMessages": [], - "availableAccounts": [], - "availableTokens": [] - }, - "marketingData": null, - "sellers": [ - { - "id": "1", - "name": "lojadobreno", - "logo": "" - } - ], - "clientPreferencesData": { - "locale": "pt-BR", - "optinNewsLetter": null - }, - "commercialConditionData": null, - "storePreferencesData": { - "countryCode": "BRA", - "saveUserData": true, - "timeZone": "E. South America Standard Time", - "currencyCode": "BRL", - "currencyLocale": 1046, - "currencySymbol": "R$", - "currencyFormatInfo": { - "currencyDecimalDigits": 2, - "currencyDecimalSeparator": ",", - "currencyGroupSeparator": ".", - "currencyGroupSize": 3, - "startsWithCurrencySymbol": true - } - }, - "giftRegistryData": null, - "openTextField": null, - "invoiceData": null, - "customData": { - "customApps": [ - { - "fields": { - "testField1": "testValue1", - "testField2": "testValue2" - }, - "id": "abcd", - "major": 1 - } - ] - }, - "itemMetadata": { - "items": [ - { - "id": "1", - "seller": "1", - "name": "Ração Royal Canin Feline Urinary 500g", - "skuName": "Ração Royal Canin Feline Urinary 500g", - "productId": "1", - "refId": "0001", - "ean": "123456789", - "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000", - "detailUrl": "/racao-royal-canin-feline-urinary/p", - "assemblyOptions": [] - } - ] - }, - "hooksData": null, - "ratesAndBenefitsData": { - "rateAndBenefitsIdentifiers": [], - "teaser": [] - }, - "subscriptionData": null, - "itemsOrdination": null - } - } - } - } - }, - "deprecated": false - } - }, - "/api/checkout/pub/orderForm/{orderFormId}/customData/{appId}/{appFieldName}": { - "put": { - "tags": [ - "Custom data" - ], - "summary": "Set single custom field value", - "description": "Your account may create `apps`, which contain custom fields, through the [Update orderForm configuration](https://developers.vtex.com/reference#updateorderformconfiguration) request. The value of a specific custom field can then be updated by this request.\n\r\n\rTo do that, you need to inform in the URL the ID of the app you created with the configuration API (`appId`).\n\r\n\rIn the body of the request, you will inform the new value (`appFieldValue`, passed through the body) of the specific field created in this app (identified by the `appFieldName` parameter, passed through the URL).\r\n\r\nThe [orderForm](https://developers.vtex.com/vtex-rest-api/reference/checkout-api-overview) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.", - "operationId": "SetSingleCustomFieldValue", - "parameters": [ - { - "name": "orderFormId", - "in": "path", - "description": "The ID of the orderForm whose custom field's value you want to change.", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - }, - { - "name": "appId", - "in": "path", - "description": "ID of the app created through the Update orderForm Configuration endpoint.", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - }, - { - "name": "appFieldName", - "in": "path", - "description": "Name of the app's field created through the Update orderForm Configuration endpoint.", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SetsinglecustomfieldvalueRequest" - }, - "example": { - "value": "{{appFieldValue}}" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "application/json": { - "example": { - "orderFormId": "ede846222cd44046ba6c638442c3505a", - "salesChannel": "1", - "loggedIn": false, - "isCheckedIn": false, - "storeId": null, - "checkedInPickupPointId": null, - "allowManualPrice": false, - "canEditData": true, - "userProfileId": null, - "userType": null, - "ignoreProfileData": false, - "value": 10000, - "messages": [], - "items": [ - { - "uniqueId": "E0F2B7AF5CD74D668F1E27537206912C", - "id": "1", - "productId": "1", - "productRefId": "", - "refId": "0001", - "ean": "123456789", - "name": "Ração Royal Canin Feline Urinary 500g", - "skuName": "Ração Royal Canin Feline Urinary 500g", - "modalType": null, - "parentItemIndex": null, - "parentAssemblyBinding": null, - "assemblies": [], - "priceValidUntil": "2021-02-27T14:59:00.8288784Z", - "tax": 0, - "price": 15000, - "listPrice": 30000, - "manualPrice": 10000, - "sellingPrice": 10000, - "rewardValue": 0, - "isGift": false, - "additionalInfo": { - "brandName": "Royal Canin", - "brandId": "2000000", - "offeringInfo": null, - "offeringType": null, - "offeringTypeId": null - }, - "preSaleDate": null, - "productCategoryIds": "/1/10/", - "productCategories": { - "10": "Ração Seca", - "1": "Alimentação" - }, - "quantity": 1, - "seller": "1", - "sellerChain": [ - "1" - ], - "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000", - "detailUrl": "/racao-royal-canin-feline-urinary/p", - "components": [], - "bundleItems": [], - "attachments": [], - "attachmentOfferings": [], - "offerings": [], - "priceTags": [ - { - "name": "DISCOUNT@MANUALPRICE", - "value": -5000, - "rawValue": -50.0, - "isPercentual": false, - "identifier": null - } - ], - "availability": "available", - "measurementUnit": "un", - "unitMultiplier": 1.0, - "manufacturerCode": null - } - ], - "selectableGifts": [], - "totalizers": [ - { - "id": "Items", - "name": "Total dos Itens", - "value": 15000 - }, - { - "id": "Discounts", - "name": "Total dos Descontos", - "value": -5000 - } - ], - "shippingData": { - "address": null, - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": null, - "selectedDeliveryChannel": "delivery", - "addressId": null, - "slas": [], - "shipsTo": [ - "BRA" - ], - "itemId": "1", - "deliveryChannels": [ - { - "id": "pickup-in-point" - }, - { - "id": "delivery" - } - ] - } - ], - "selectedAddresses": [], - "availableAddresses": [], - "pickupPoints": [] - }, - "clientProfileData": null, - "paymentData": { - "installmentOptions": [ - { - "paymentSystem": "2", - "bin": null, - "paymentName": null, - "paymentGroupName": null, - "value": 10000, - "installments": [ - { - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 10000, - "total": 10000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 10000, - "total": 10000 - } - ] - }, - { - "count": 2, - "hasInterestRate": false, - "interestRate": 0, - "value": 5000, - "total": 10000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 2, - "hasInterestRate": false, - "interestRate": 0, - "value": 5000, - "total": 10000 - } - ] - } - ] - } - ], - "paymentSystems": [ - { - "id": 2, - "name": "Visa", - "groupName": "creditCardPaymentGroup", - "validator": { - "regex": "^4[0-9]{15}$", - "mask": "9999 9999 9999 9999", - "cardCodeRegex": "^[0-9]{3}$", - "cardCodeMask": "999", - "weights": [ - 2, - 1, - 2, - 1, - 2 - ], - "useCvv": true, - "useExpirationDate": true, - "useCardHolderName": true, - "useBillingAddress": true - }, - "stringId": "2", - "template": "creditCardPaymentGroup-template", - "requiresDocument": false, - "isCustom": false, - "description": null, - "requiresAuthentication": false, - "dueDate": "2020-03-05T16:42:31.7836281Z", - "availablePayments": null - } - ], - "payments": [], - "giftCards": [], - "giftCardMessages": [], - "availableAccounts": [], - "availableTokens": [] - }, - "marketingData": null, - "sellers": [ - { - "id": "1", - "name": "lojadobreno", - "logo": "" - } - ], - "clientPreferencesData": { - "locale": "pt-BR", - "optinNewsLetter": null - }, - "commercialConditionData": null, - "storePreferencesData": { - "countryCode": "BRA", - "saveUserData": true, - "timeZone": "E. South America Standard Time", - "currencyCode": "BRL", - "currencyLocale": 1046, - "currencySymbol": "R$", - "currencyFormatInfo": { - "currencyDecimalDigits": 2, - "currencyDecimalSeparator": ",", - "currencyGroupSeparator": ".", - "currencyGroupSize": 3, - "startsWithCurrencySymbol": true - } - }, - "giftRegistryData": null, - "openTextField": null, - "invoiceData": null, - "customData": { - "customApps": [ - { - "fields": { - "testField1": "Hello World", - "testField2": "testValue2" - }, - "id": "abcd", - "major": 1 - } - ] - }, - "itemMetadata": { - "items": [ - { - "id": "1", - "seller": "1", - "name": "Ração Royal Canin Feline Urinary 500g", - "skuName": "Ração Royal Canin Feline Urinary 500g", - "productId": "1", - "refId": "0001", - "ean": "123456789", - "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000", - "detailUrl": "/racao-royal-canin-feline-urinary/p", - "assemblyOptions": [] - } - ] - }, - "hooksData": null, - "ratesAndBenefitsData": { - "rateAndBenefitsIdentifiers": [], - "teaser": [] - }, - "subscriptionData": null, - "itemsOrdination": null - } - } - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Custom data" - ], - "summary": "Remove single custom field value", - "description": "Your account may create `apps`, which contain custom fields, through the [Update orderForm configuration](https://developers.vtex.com/reference#updateorderformconfiguration) request. The value of a specific custom field can be removed by this request.\n\r\n\rTo do that, you need to inform in the URL the ID of the app you created with the configuration API (`appId`).\n\r\n\rYou also need to iform the specific field created in this app (identified by the `appFieldName` parameter, also passed through the URL) whose value you want to remove.", - "operationId": "Removesinglecustomfieldvalue", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "orderFormId", - "in": "path", - "description": "The ID of the orderForm from which you want to remove the custom field value.", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - }, - { - "name": "appId", - "in": "path", - "description": "ID of the app created through the Update orderForm Configuration endpoint.", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - }, - { - "name": "appFieldName", - "in": "path", - "description": "Name of the app's field created through the Update orderForm Configuration endpoint and which will be deleted.", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "orderFormId": "ede846222cd44046ba6c638442c3505a", - "salesChannel": "1", - "loggedIn": false, - "isCheckedIn": false, - "storeId": null, - "checkedInPickupPointId": null, - "allowManualPrice": false, - "canEditData": true, - "userProfileId": null, - "userType": null, - "ignoreProfileData": false, - "value": 10000, - "messages": [], - "items": [ - { - "uniqueId": "E0F2B7AF5CD74D668F1E27537206912C", - "id": "1", - "productId": "1", - "productRefId": "", - "refId": "0001", - "ean": "123456789", - "name": "Ração Royal Canin Feline Urinary 500g", - "skuName": "Ração Royal Canin Feline Urinary 500g", - "modalType": null, - "parentItemIndex": null, - "parentAssemblyBinding": null, - "assemblies": [], - "priceValidUntil": "2021-02-27T14:59:00.8288784Z", - "tax": 0, - "price": 15000, - "listPrice": 30000, - "manualPrice": 10000, - "sellingPrice": 10000, - "rewardValue": 0, - "isGift": false, - "additionalInfo": { - "brandName": "Royal Canin", - "brandId": "2000000", - "offeringInfo": null, - "offeringType": null, - "offeringTypeId": null - }, - "preSaleDate": null, - "productCategoryIds": "/1/10/", - "productCategories": { - "10": "Ração Seca", - "1": "Alimentação" - }, - "quantity": 1, - "seller": "1", - "sellerChain": [ - "1" - ], - "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000", - "detailUrl": "/racao-royal-canin-feline-urinary/p", - "components": [], - "bundleItems": [], - "attachments": [], - "attachmentOfferings": [], - "offerings": [], - "priceTags": [ - { - "name": "DISCOUNT@MANUALPRICE", - "value": -5000, - "rawValue": -50.0, - "isPercentual": false, - "identifier": null - } - ], - "availability": "available", - "measurementUnit": "un", - "unitMultiplier": 1.0, - "manufacturerCode": null - } - ], - "selectableGifts": [], - "totalizers": [ - { - "id": "Items", - "name": "Total dos Itens", - "value": 15000 - }, - { - "id": "Discounts", - "name": "Total dos Descontos", - "value": -5000 - } - ], - "shippingData": { - "address": null, - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": null, - "selectedDeliveryChannel": "delivery", - "addressId": null, - "slas": [], - "shipsTo": [ - "BRA" - ], - "itemId": "1", - "deliveryChannels": [ - { - "id": "pickup-in-point" - }, - { - "id": "delivery" - } - ] - } - ], - "selectedAddresses": [], - "availableAddresses": [], - "pickupPoints": [] - }, - "clientProfileData": null, - "paymentData": { - "installmentOptions": [ - { - "paymentSystem": "2", - "bin": null, - "paymentName": null, - "paymentGroupName": null, - "value": 10000, - "installments": [ - { - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 10000, - "total": 10000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 10000, - "total": 10000 - } - ] - }, - { - "count": 2, - "hasInterestRate": false, - "interestRate": 0, - "value": 5000, - "total": 10000, - "sellerMerchantInstallments": [ - { - "id": "LOJADOBRENO", - "count": 2, - "hasInterestRate": false, - "interestRate": 0, - "value": 5000, - "total": 10000 - } - ] - } - ] - } - ], - "paymentSystems": [ - { - "id": 2, - "name": "Visa", - "groupName": "creditCardPaymentGroup", - "validator": { - "regex": "^4[0-9]{15}$", - "mask": "9999 9999 9999 9999", - "cardCodeRegex": "^[0-9]{3}$", - "cardCodeMask": "999", - "weights": [ - 2, - 1, - 2, - 1, - 2 - ], - "useCvv": true, - "useExpirationDate": true, - "useCardHolderName": true, - "useBillingAddress": true - }, - "stringId": "2", - "template": "creditCardPaymentGroup-template", - "requiresDocument": false, - "isCustom": false, - "description": null, - "requiresAuthentication": false, - "dueDate": "2020-03-05T16:42:31.7836281Z", - "availablePayments": null - } - ], - "payments": [], - "giftCards": [], - "giftCardMessages": [], - "availableAccounts": [], - "availableTokens": [] - }, - "marketingData": null, - "sellers": [ - { - "id": "1", - "name": "lojadobreno", - "logo": "" - } - ], - "clientPreferencesData": { - "locale": "pt-BR", - "optinNewsLetter": null - }, - "commercialConditionData": null, - "storePreferencesData": { - "countryCode": "BRA", - "saveUserData": true, - "timeZone": "E. South America Standard Time", - "currencyCode": "BRL", - "currencyLocale": 1046, - "currencySymbol": "R$", - "currencyFormatInfo": { - "currencyDecimalDigits": 2, - "currencyDecimalSeparator": ",", - "currencyGroupSeparator": ".", - "currencyGroupSize": 3, - "startsWithCurrencySymbol": true - } - }, - "giftRegistryData": null, - "openTextField": null, - "invoiceData": null, - "customData": { - "customApps": [ - { - "fields": { - "testField2": "testValue2" - }, - "id": "abcd", - "major": 1 - } - ] - }, - "itemMetadata": { - "items": [ - { - "id": "1", - "seller": "1", - "name": "Ração Royal Canin Feline Urinary 500g", - "skuName": "Ração Royal Canin Feline Urinary 500g", - "productId": "1", - "refId": "0001", - "ean": "123456789", - "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000", - "detailUrl": "/racao-royal-canin-feline-urinary/p", - "assemblyOptions": [] - } - ] - }, - "hooksData": null, - "ratesAndBenefitsData": { - "rateAndBenefitsIdentifiers": [], - "teaser": [] - }, - "subscriptionData": null, - "itemsOrdination": null - } - } - } - } - }, - "deprecated": false - } - }, - "/api/checkout/pvt/configuration/orderForm": { - "get": { - "tags": [ - "Configuration" - ], - "summary": "Get orderForm configuration", - "description": "Retrieves the settings that are currently applied to every orderForm in the account.\n\r\n\rThese settings are defined by the request [Update orderForm configuration](https://developers.vtex.com/reference/configuration#updateorderformconfiguration).\n\r\n\rAlways use this request to retrieve the current configuration before performing an update. By doing so you ensure that you are modifying only the properties you want.", - "operationId": "GetorderFormconfiguration", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "application/json": { - "schema": {}, - "example": { - "paymentConfiguration": { - "requiresAuthenticationForPreAuthorizedPaymentOption": false, - "allowInstallmentsMerge": null, - "blockPaymentSession": null - }, - "taxConfiguration": null, - "minimumQuantityAccumulatedForItems": 1, - "decimalDigitsPrecision": 2, - "minimumValueAccumulated": null, - "apps": [ - { - "fields": [ - "name", - "age" - ], - "id": "abcd", - "major": 1 - } - ], - "allowMultipleDeliveries": false, - "allowManualPrice": true, - "maxNumberOfWhiteLabelSellers": null, - "maskFirstPurchaseData": null, - "recaptchaValidation": "vtexCriteria" - } - } - } - } - }, - "deprecated": false - }, - "post": { - "tags": [ - "Configuration" - ], - "summary": "Update orderForm configuration", - "description": "Determines settings that will apply to every orderForm in the account.\n\r\n\rFor example, if you create an app using this request, every orderForm of this account will have the custom fields created though it.\n\r\n\r**Important**: always retrieve the current configuration before performing an update to ensure that you are modifying only the properties you want. Otherwise, old values can be overwritten. To retrieve the current configuration, use the request [Get orderForm configuration](https://developers.vtex.com/reference#getorderformconfiguration).", - "operationId": "UpdateorderFormconfiguration", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateorderFormconfigurationRequest" - }, - "example": { - "paymentConfiguration": { - "requiresAuthenticationForPreAuthorizedPaymentOption": false - }, - "taxConfiguration": null, - "minimumQuantityAccumulatedForItems": 1, - "decimalDigitsPrecision": 2, - "minimumValueAccumulated": null, - "apps": null, - "allowMultipleDeliveries": null, - "allowManualPrice": null - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "", - "headers": {} - } - }, - "deprecated": false - } - }, - "/api/checkout/pvt/configuration/window-to-change-seller": { - "get": { - "tags": [ - "Configuration" - ], - "summary": "Get window to change seller", - "description": "Retrieves a marketplace’s window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it.\n\r\n\rThe default period for this window is of 2 days, but it can be configured by the request Update window to change seller.", - "operationId": "GetWindowToChangeSeller", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "text/plain": { - "example": "2" - } - } - } - }, - "deprecated": false - }, - "post": { - "tags": [ - "Configuration" - ], - "summary": "Update window to change seller", - "description": "Updates a marketplace’s window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it.\n\r\n\rIt is possible to check the current window using the request Get window to change seller.", - "operationId": "UpdateWindowToChangeSeller", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WaitingTime" - }, - "example": { - "waitingTime": 4 - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Created", - "headers": {} - } - }, - "deprecated": false - } - }, - "/api/checkout/pub/orderForm/{orderFormId}/installments": { - "get": { - "tags": [ - "Shopping cart" - ], - "summary": "Cart installments", - "description": "Retrieves possible amount of installments and respective values for a given cart with a given payment method.\r\n\r\nThe [orderForm](https://developers.vtex.com/vtex-rest-api/reference/checkout-api-overview) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\rThis endpoint can be used to get the installment options for only one payment method at a time.\n\r\n\rThis endpoint should be called only after the selected `orderForm` already has a `paymentData`.", - "operationId": "GetCartInstallments", - "parameters": [ - { - "name": "orderFormId", - "in": "path", - "required": true, - "description": "ID of the `orderForm` to be consulted for installments.", - "schema": { - "type": "string" - } - }, - { - "name": "paymentSystem", - "in": "query", - "description": "ID of the payment method to be consulted for installments.", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "integer" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "OK", - "headers": {}, - "content": { - "application/json": { - "example": { - "paymentSystem": "2", - "bin": null, - "paymentName": null, - "paymentGroupName": null, - "value": 32000, - "installments": [ - { - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 32000, - "total": 32000, - "sellerMerchantInstallments": [ - { - "id": "MyStore", - "count": 1, - "hasInterestRate": false, - "interestRate": 0, - "value": 32000, - "total": 32000 - } - ] - }, - { - "count": 2, - "hasInterestRate": false, - "interestRate": 0, - "value": 1600, - "total": 32000, - "sellerMerchantInstallments": [ - { - "id": "MyStore", - "count": 2, - "hasInterestRate": false, - "interestRate": 0, - "value": 1600, - "total": 32000 - } - ] - }, - { - "count": 3, - "hasInterestRate": false, - "interestRate": 0, - "value": 10666, - "total": 32000, - "sellerMerchantInstallments": [ - { - "id": "MyStore", - "count": 3, - "hasInterestRate": false, - "interestRate": 0, - "value": 10666, - "total": 32000 - } - ] - } - ] - } - } - } - } - }, - "deprecated": false - } - }, - "/api/checkout/pub/pickup-points": { - "get": { - "tags": [ - "Fulfillment" - ], - "summary": "List pickup points by location", - "description": "Retrieves information on pickup points close to a given location determined by geocoordinates or postal code.\n\r\n\rThe pickup points returned are not necessarily all active ones. Make sure to validate the information consumed by integrations.", - "operationId": "ListPickupPpointsByLocation", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "geoCoordinates", - "in": "query", - "description": "Geocoordinates around which to search for pickup points. If you use this type of search, do not pass postal and country codes.", - "required": false, - "style": "form", - "schema": { - "type": "string", - "default": "00.0000000;00.0000000" - } - }, - { - "name": "postalCode", - "in": "query", - "description": "Postal code around which to search for pickup points. If you use this type of search, make sure to pass a `countryCode` and do not pass `geoCoordinates`.", - "required": false, - "style": "form", - "schema": { - "type": "string", - "default": "1234000" - } - }, - { - "name": "countryCode", - "in": "query", - "description": "Three letter country code refering to the `postalCode` field. Pass the country code only if you are searching pickup points by postal code.", - "required": false, - "style": "form", - "schema": { - "type": "string", - "default": "BRA" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "paging": { - "page": 1, - "pageSize": 30, - "total": 1, - "pages": 1 - }, - "items": [ - { - "distance": 0.84697865186165456, - "pickupPoint": { - "friendlyName": "physical-store-02", - "address": { - "addressType": "pickup", - "receiverName": null, - "addressId": "physical-store-02", - "isDisposable": true, - "postalCode": "23450-070", - "city": "Rio de Janeiro", - "state": "RJ", - "country": "BRA", - "street": "Praia de Botafogo", - "number": "132", - "neighborhood": "Botafogo", - "complement": "", - "reference": null, - "geoCoordinates": [ - -34.18259, - -11.94436 - ] - }, - "additionalInfo": null, - "id": "02_Physical", - "businessHours": [ - { - "DayOfWeek": 0, - "OpeningTime": "00:00:00", - "ClosingTime": "23:59:00" - }, - { - "DayOfWeek": 1, - "OpeningTime": "00:00:00", - "ClosingTime": "23:59:00" - }, - { - "DayOfWeek": 2, - "OpeningTime": "00:00:00", - "ClosingTime": "23:59:00" - }, - { - "DayOfWeek": 3, - "OpeningTime": "00:00:00", - "ClosingTime": "23:59:00" - }, - { - "DayOfWeek": 4, - "OpeningTime": "00:00:00", - "ClosingTime": "23:50:00" - }, - { - "DayOfWeek": 5, - "OpeningTime": "00:00:00", - "ClosingTime": "23:59:00" - }, - { - "DayOfWeek": 6, - "OpeningTime": "00:00:00", - "ClosingTime": "23:59:00" - } - ] - } - } - ] - } - } - } - } - } - } - }, - "/api/checkout/pub/postal-code/{countryCode}/{postalCode}": { - "get": { - "tags": [ - "Fulfillment" - ], - "summary": "Get address by postal code", - "description": "Retrieves address information for a given postal code and country.\r\n\r\nThis request can be used to implement auto complete functionality when a customer needs to fill in an address.", - "operationId": "GetAddressByPostalCode", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "countryCode", - "in": "path", - "description": "Three letter country code refering to the `postalCode` field.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "BRA" - } - }, - { - "name": "postalCode", - "in": "path", - "description": "Postal code.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "1234000" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": { - "postalCode": "12345000", - "city": "Rio de Janeiro", - "state": "RJ", - "country": "BRA", - "street": "My street", - "number": "", - "neighborhood": "My neighborhood", - "complement": "", - "reference": "", - "geoCoordinates": [] - } - } - } - } - } - } - }, - "/api/checkout/pub/orderForm/{orderFormId}/transaction": { - "post": { - "tags": [ - "Order placement" - ], - "summary": "Place order from an existing cart", - "description": "This endpoint places an order from an existing `orderForm` object, meaning an existing cart.\n\r\n\rAfter the creation of an order with this request, you have five minutes to send payment information and then request payment processing.", - "operationId": "PlaceOrderFromExistingOrderForm", - "parameters": [ - { - "name": "orderFormId", - "in": "path", - "description": "ID of the `orderForm` corresponding to the cart from which to place the order.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "ede846222cd44046ba6c638442c3505a" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "title": "", - "required": [ - "referenceId", - "value", - "referenceValue", - "interestValue" - ], - "properties": { - "referenceId": { - "title": "referenceId", - "type": "string", - "description": "ID of the `orderForm` corresponding to the cart from which to place the order. This is the same as the `orderFormId` parameter.", - "default": "41a22925298a4ddca95318131a25b000" - }, - "savePersonalData": { - "title": "savePersonalData", - "type": "boolean", - "description": "`true` if the shopper's data provided during checkout should be saved for future reference.", - "default": false - }, - "optinNewsLetter": { - "title": "optinNewsLetter", - "type": "boolean", - "description": "True if the shopper opted to receive the newsletter.", - "default": false - }, - "value": { - "type": "integer", - "description": "Total value of the order without separating cents. For example, $24.99 is represented `2499`.", - "default": 6800 - }, - "referenceValue": { - "type": "integer", - "description": "Reference value of the order for calculating interest if that is the case. Can be equal to the total value and does not separate cents. For example, $24.99 is represented `2499`.", - "default": 6800 - }, - "interestValue": { - "type": "integer", - "description": "Interest rate to be used in case it applies.", - "default": 0 - } - } - } - } - } - }, - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "application/json": { - "schema": { - "type": "object" - }, - "example": { - "orderForm": null, - "transactionData": { - "merchantTransactions": [ - { - "id": "STORE", - "transactionId": "62FEDE228E2144649CF67812C4E5ER79", - "merchantName": "STORE", - "payments": [ - { - "paymentSystem": "6", - "bin": null, - "accountId": null, - "value": 15650, - "referenceValue": 15650, - "giftCardRedemptionCode": null, - "giftCardProvider": null, - "giftCardId": null - } - ] - } - ], - "receiverUri": "https://store.vtexpayments.com.br/split/v976778amgh/payments", - "gatewayCallbackTemplatePath": "/checkout/gatewayCallback/v976778amgh/{messageCode}" - }, - "orders": [ - { - "orderId": "v976778amgh-01", - "orderGroup": "v976778amgh", - "state": "order-created", - "isCheckedIn": false, - "sellerOrderId": "00-v976778amgh-01", - "storeId": null, - "value": 15650, - "items": [ - { - "uniqueId": "0F93E9C4926A4CD97FDD4C2599BDF9DB", - "id": "2000016", - "productId": "2000002", - "refId": "35-Preto", - "ean": null, - "name": "Produto Seleção SKU - Lista 35 - Preto", - "skuName": "35 - Preto", - "modalType": null, - "priceValidUntil": "2018-02-16T23:42:44.5467295Z", - "tax": 0, - "price": 15000, - "listPrice": 15000, - "manualPrice": null, - "sellingPrice": 15000, - "rewardValue": 1, - "isGift": false, - "additionalInfo": { - "brandName": "Marca Um", - "brandId": "1", - "offeringInfo": null, - "offeringType": null, - "offeringTypeId": null - }, - "preSaleDate": null, - "productCategoryIds": "/12/28/", - "productCategories": { - "28": "Categoria 5-3", - "12": "Departamento 5" - }, - "defaultPicker": null, - "handlerSequence": 0, - "handling": false, - "quantity": 1, - "seller": "1", - "imageUrl": "http://store.vteximg.com.br/arquivos/ids/168463-55-55/imagem-modo-lista.png", - "detailUrl": "/produto-selecao-sku-lista/p", - "components": [], - "bundleItems": [], - "attachments": [], - "itemAttachment": { - "name": null, - "content": {} - }, - "attachmentOfferings": [], - "offerings": [], - "priceTags": [], - "availability": "available", - "measurementUnit": "un", - "unitMultiplier": 1.0 - } - ], - "sellers": [ - { - "id": "1", - "name": "Store", - "logo": "" - } - ], - "totals": [ - { - "id": "Items", - "name": "Total dos Itens", - "value": 15000 - }, - { - "id": "Discounts", - "name": "Total dos Descontos", - "value": 0 - }, - { - "id": "Shipping", - "name": "Total do Frete", - "value": 650 - }, - { - "id": "Tax", - "name": "Total da Taxa", - "value": 0 - } - ], - "clientProfileData": { - "attachmentId": "clientProfileData", - "email": "marcelo@vtex.com.br", - "firstName": "Marcelo", - "lastName": "Couto", - "document": "71279846675", - "documentType": "cpf", - "phone": "1234567890", - "corporateName": null, - "tradeName": null, - "corporateDocument": null, - "stateInscription": null, - "corporatePhone": null, - "isCorporate": false, - "profileCompleteOnLoading": null, - "profileErrorOnLoading": null - }, - "ratesAndBenefitsData": { - "attachmentId": "ratesAndBenefitsData", - "rateAndBenefitsIdentifiers": [], - "teaser": [] - }, - "shippingData": { - "attachmentId": "shippingData", - "address": { - "addressType": "residential", - "receiverName": "Marcelo", - "addressId": "49ad09e5fba8434a8ff1e0faa4b60ceb", - "postalCode": "28050987", - "city": "Rio de Janeiro", - "state": "RJ", - "country": "BRA", - "street": "Rua da minha casa", - "number": "123", - "neighborhood": "Copacabana", - "complement": "15º andar", - "reference": null, - "geoCoordinates": [] - }, - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": "Normal", - "slas": [ - { - "id": "n2_2", - "name": "n2_2", - "deliveryIds": [ - { - "courierId": "1de4790", - "warehouseId": "1_1", - "dockId": "N2", - "courierName": "N2_2", - "quantity": 1 - } - ], - "shippingEstimate": "6bd", - "shippingEstimateDate": null, - "lockTTL": "7d", - "availableDeliveryWindows": [ - { - "startDateUtc": "2017-03-27T00:00:00+00:00", - "endDateUtc": "2017-03-27T00:00:00+00:00", - "price": 0, - "lisPrice": 0, - "tax": 0 - }, - { - "startDateUtc": "2017-03-28T00:00:00+00:00", - "endDateUtc": "2017-03-28T00:00:00+00:00", - "price": 0, - "lisPrice": 0, - "tax": 0 - } - ], - "deliveryWindow": null, - "price": 650, - "listPrice": 650, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - } - }, - { - "id": "Normal", - "name": "Normal", - "deliveryIds": [ - { - "courierId": "2p1t", - "warehouseId": "1_1", - "dockId": "N2", - "courierName": "Post_Test_2", - "quantity": 1 - } - ], - "shippingEstimate": "6bd", - "shippingEstimateDate": null, - "lockTTL": "7d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 650, - "listPrice": 650, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - } - }, - { - "id": "P_T", - "name": "P_T", - "deliveryIds": [ - { - "courierId": "1p1t", - "warehouseId": "1_1", - "dockId": "N2", - "courierName": "Post_Teste", - "quantity": 1 - } - ], - "shippingEstimate": "6bd", - "shippingEstimateDate": null, - "lockTTL": "7d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 1462, - "listPrice": 1462, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - } - }, - { - "id": "Econômica", - "name": "Econômica", - "deliveryIds": [ - { - "courierId": "2B9C2C7D-7A76-485D-94EF-701D041E448C", - "warehouseId": "1_1", - "dockId": "1_1_1", - "courierName": "Leve 30kg (De: 10000-000 Até: 25999-999) ", - "quantity": 1 - } - ], - "shippingEstimate": "20bd", - "shippingEstimateDate": null, - "lockTTL": "7d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 2265, - "listPrice": 2265, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - } - } - ], - "shipsTo": [ - "BRA" - ], - "itemId": "2000016" - } - ], - "availableAddresses": [ - { - "addressType": "residential", - "receiverName": "Marcelo", - "addressId": "49ad09e5fba8434a8ff1e0faa4b60ceb", - "postalCode": "28050642", - "city": "Rio de Janeiro", - "state": "RJ", - "country": "BRA", - "street": "Rua da minha casa", - "number": "123", - "neighborhood": "Copacabana", - "complement": "15º andar", - "reference": null, - "geoCoordinates": [] - } - ] - }, - "paymentData": { - "attachmentId": "paymentData", - "transactionId": "62FEDE228E2144649CF67812C4E5DD87", - "payments": [], - "giftCards": [], - "transactions": [ - { - "isActive": true, - "transactionId": "62FEDE228E2144649CF67812C4E5DD87", - "merchantName": "STORE", - "payments": [] - } - ], - "merchantName": "STORE" - }, - "clientPreferencesData": { - "attachmentId": "clientPreferencesData", - "locale": "pt-BR", - "optinNewsLetter": true - }, - "giftRegistryData": null, - "marketingData": null, - "storePreferencesData": { - "countryCode": "BRA", - "checkToSavePersonDataByDefault": false, - "templateOptions": { - "toggleCorporate": false - }, - "timeZone": "E. South America Standard Time", - "currencyCode": "BRL", - "currencyLocale": 1046, - "currencySymbol": "R$", - "currencyFormatInfo": { - "currencyDecimalDigits": 2, - "currencyDecimalSeparator": ",", - "currencyGroupSeparator": ".", - "currencyGroupSize": 3, - "startsWithCurrencySymbol": true - } - }, - "openTextField": { - "attachmentId": "openTextField", - "value": null - }, - "changeData": null, - "salesChannel": "1", - "followUpEmail": "f1e7309d88dd4633825ce183d52a50a6@ct.vtex.com.br", - "creationDate": "2017-02-16T23:42:43.9605088Z", - "lastChange": "2017-02-16T23:42:47.62285Z", - "timeZoneCreationDate": "2017-02-16T21:42:43.9605088", - "timeZoneLastChange": "2017-02-16T21:42:47.62285", - "isCompleted": false, - "hostName": "ambienteqa", - "merchantName": null, - "userType": "", - "roundingError": 0 - } - ] - } - } - } - } - }, - "deprecated": false - } - }, - "/api/checkout/pub/orders": { - "put": { - "tags": [ - "Order placement" - ], - "summary": "Place order", - "description": "Places order without having any prior cart information. This means all information on items, client, payment and shipping mus be sent in the body.", - "operationId": "PlaceOrder", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "items", - "clientProfileData", - "shippingData", - "paymentData" - ], - "properties": { - "items": { - "type": "array", - "description": "Array of objects containing information on each of the order's items.", - "items": { - "type": "object", - "required": [ - "id", - "quantity", - "seller" - ], - "properties": { - "id": { - "type": "string", - "description": "The SKU ID.", - "example": "123" - }, - "quantity": { - "type": "integer", - "format": "int32", - "description": "The quantity of items of this specific SKU in the cart to be simulated.", - "example": 1 - }, - "seller": { - "type": "string", - "description": "The ID of the seller responsible for this SKU. This ID can be found in your VTEX Admin.", - "example": "1" - }, - "commission": { - "type": "integer", - "description": "Comission.", - "example": 10 - }, - "freightCommission": { - "type": "integer", - "description": "Freight comission", - "example": 10 - }, - "price": { - "type": "integer", - "description": "Item price within the context of the order without separating cents. For example, $24.99 is represented `2499`.", - "example": 2499 - }, - "bundleItems": { - "type": "array", - "description": "Information on services sold along with the SKU. Example: a gift package.", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Service type.", - "example": "type-example" - }, - "id": { - "type": "string", - "description": "Service identifier.", - "example": "id-example" - }, - "name": { - "type": "string", - "description": "Service name.", - "example": "name-example" - }, - "price": { - "type": "integer", - "description": "Service price. The last two digits are the cents.", - "example": 199 - } - } - } - }, - "itemAttachment": { - "type": "object", - "description": "Item attachment.", - "properties": { - "name": { - "type": "string", - "description": "Attachment name.", - "example": "name-example" - }, - "content": { - "type": "string", - "description": "Content referring to the customization requested by the customer.", - "example": "content-example" - } - } - }, - "attachments": { - "type": "array", - "description": "Array containing information on attachments.", - "items": { - "type": "string" - } - }, - "priceTags": { - "type": "array", - "description": "Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order.", - "items": { - "type": "object", - "properties": { - "identifier": { - "type": "string", - "description": "Price tag identifier.", - "default": "1234abc-5678b-1234c" - }, - "isPercentual": { - "type": "boolean", - "description": "`true` if price tag value is applied through a percentage.", - "default": false - }, - "name": { - "type": "string", - "description": "Price tag name.", - "default": "discount@name-1234abc-5678b-1234c" - }, - "rawValue": { - "type": "integer", - "description": "Price tag raw value.", - "default": -12 - }, - "value": { - "type": "integer", - "description": "Price tag value.", - "default": -1200 - } - } - } - }, - "measurementUnit": { - "type": "string", - "description": "SKU measurement unit.", - "default": "g" - }, - "unitMultiplier": { - "type": "integer", - "description": "SKU unit multiplier.", - "default": 1 - }, - "isGift": { - "type": "boolean", - "description": "Indicates whether the order is a gift.", - "default": false - } - }, - "example": { - "id": "123456789", - "quantity": 1, - "seller": "1" - } - } - }, - "clientProfileData": { - "type": "object", - "description": "Customer's profile information. The `email` functions as a customer's ID.\n\r\n\rFor customers already in your database, sending only the email address is enough to register the order to the shopper’s existing account.\n\r\n\r> If the shopper exists in you database but is not logged in, sending other profile information along with the email will cause the platform to fail placing the order. This happens because this action is interpreted as an attempt to edit profile data, which is not possible unless the customer is logged in to the store.", - "required": [ - "email" - ], - "properties": { - "email": { - "type": "string", - "description": "Customer's email address.", - "default": "customer@examplemail.com" - }, - "firstName": { - "type": "string", - "description": "Customer's first name.", - "default": "first-name" - }, - "lastName": { - "type": "string", - "description": "Customer's last name.", - "default": "last-name" - }, - "documentType": { - "type": "string", - "description": "Type of the document informed by the customer.", - "default": "cpf" - }, - "document": { - "type": "string", - "description": "Document number informed by the customer.", - "default": "123456789" - }, - "phone": { - "type": "string", - "description": "Customer's phone number.", - "default": "+55110988887777" - }, - "corporateName": { - "type": "string", - "description": "Company name, if the customer is a legal entity.", - "default": "company-name" - }, - "tradeName": { - "type": "string", - "description": "Trade name, if the customer is a legal entity.", - "default": "trade-name" - }, - "corporateDocument": { - "type": "string", - "description": "Corporate document, if the customer is a legal entity.", - "default": "12345678000100" - }, - "stateInscription": { - "type": "string", - "description": "State inscription, if the customer is a legal entity.", - "default": "12345678" - }, - "corporatePhone": { - "type": "string", - "description": "Corporate phone number, if the customer is a legal entity.", - "default": "+551100988887777" - }, - "isCorporate": { - "type": "boolean", - "description": "`true` if the customer is a legal entity.", - "default": false - } - } - }, - "shippingData": { - "type": "object", - "description": "Shipping information.", - "properties": { - "address": { - "type": "object", - "description": "Shipping address.\n\r\n\rFor customers already in your data base, it is enough to send this object only with an `addressId`, which you may obtain from a [Cart simulation request](https://developers.vtex.com/vtex-rest-api/reference/shopping-cart#cartsimulation), for example.", - "properties": { - "addressType": { - "type": "string", - "description": "Type of address. For example, `Residential` or `Pickup`, among others.", - "example": "residential" - }, - "receiverName": { - "type": "string", - "description": "Name of the person who is going to receive the order.", - "default": "receiver-name" - }, - "addressId": { - "type": "string", - "description": "Address ID.", - "default": "Home" - }, - "postalCode": { - "type": "string", - "description": "Postal Code.", - "default": "12345-000" - }, - "city": { - "type": "string", - "description": "City of the shipping address.", - "default": "Rio de Janeiro" - }, - "state": { - "type": "string", - "description": "State of the shipping address.", - "default": "Rio de Janeiro" - }, - "country": { - "type": "string", - "description": "Three letter ISO code of the country of the shipping address.", - "default": "BRA" - }, - "street": { - "type": "string", - "description": "Street of the shipping address.", - "default": "Praia de Botafogo" - }, - "number": { - "type": "string", - "description": "Number of the building, house or apartment in the shipping address.", - "default": "300" - }, - "neighborhood": { - "type": "string", - "description": "Neighborhood of the shipping address.", - "default": "Botafogo" - }, - "complement": { - "type": "string", - "description": "Complement to the shipping address in case it applies.", - "default": "3rd floor" - }, - "reference": { - "type": "string", - "description": "Complement that might help locate the shipping address more precisely in case of delivery.", - "default": "Grey building" - }, - "geoCoordinates": { - "type": "array", - "description": "Array with two strings with geocoordinates, first latitude, then longitude.", - "items": { - "type": "string", - "default": "00.00000" - } - } - } - }, - "logisticsInfo": { - "type": "array", - "description": "Array of objects containing logistics information of each item.", - "items": { - "type": "object", - "required": [ - "itemIndex", - "selectedSla", - "price" - ], - "properties": { - "itemIndex": { - "type": "integer", - "description": "Index of the item in the `items` array, starting from 0.", - "default": 0 - }, - "selectedSla": { - "type": "string", - "description": "Selected shipping option", - "default": "Express" - }, - "lockTTL": { - "type": "string", - "description": "Logistics reservation waiting time.", - "default": "8d" - }, - "shippingEstimate": { - "type": "string", - "description": "Estimated time until delivery for the item.", - "default": "7d" - }, - "price": { - "type": "integer", - "description": "Shipping price for the item. Does not account for the whole order's shipping price.", - "default": 1099 - }, - "deliveryWindow": { - "type": "object", - "description": "In case of scheduled delivery, this object will contain information on the delivery window selected by the shopper.", - "properties": { - "startDateUtc": { - "type": "string", - "description": "Delivery window starting day and time in UTC.", - "default": "2021-07-13T00:00:00+00:00" - }, - "endDateUtc": { - "type": "string", - "description": "Delivery window ending day and time in UTC.", - "default": "2021-07-13T23:59:59+00:00" - }, - "price": { - "type": "integer", - "description": "Delivery window price.", - "default": 0 - }, - "lisPrice": { - "type": "integer", - "description": "Delivery window list price.", - "default": 0 - }, - "tax": { - "type": "integer", - "description": "Delivery window tax.", - "default": 0 - } - } - } - } - } - }, - "updateStatus": { - "type": "string", - "description": "Indicate whether this object's information is up to date according to the order's items. An order can not be placed if `\"outdated\"`", - "default": "updated" - } - } - }, - "paymentData": { - "type": "object", - "required": [ - "payments" - ], - "description": "Payment infomation.", - "properties": { - "giftCards": { - "type": "array", - "description": "Gift card information, if it applies to the order.", - "items": { - "type": "object", - "required": [ - "redemptionCode", - "value" - ], - "properties": { - "redemptionCode": { - "type": "string", - "description": "Gift card redemption code.", - "example": "HYUO-TEZZ-QFFT-HTFR" - }, - "value": { - "type": "integer", - "description": "Gift card value.", - "example": 500 - }, - "balance": { - "type": "integer", - "description": "Gift card balance.", - "example": 500 - }, - "name": { - "type": "string", - "description": "Gift card name.", - "example": "name-example" - }, - "id": { - "type": "string", - "description": "Gift card ID.", - "example": "1390324156495k195pmab4rall3di" - }, - "inUse": { - "type": "boolean", - "description": "Indicates whether gift card is in use.", - "example": true - }, - "isSpecialCard": { - "type": "boolean", - "description": "Indicates whether gift card is special.", - "example": false - } - } - } - }, - "giftCardMessages": { - "type": "array", - "description": "Array of gift card messages.", - "items": { - "default": "message-example" - } - }, - "paymentSystems": { - "type": "array", - "description": "Information on payment systems.", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Payment system ID.", - "example": 2 - }, - "name": { - "type": "string", - "description": "Payment system name.", - "example": "Visa" - }, - "groupName": { - "type": "string", - "description": "Payment group name.", - "example": "creditCardPaymentGroup" - }, - "validator": { - "type": "object", - "description": "Payment system validator.", - "properties": { - "regex": { - "type": "string", - "description": "", - "example": "^4" - }, - "mask": { - "type": "string", - "description": "Validator mask.", - "example": "9999 9999 9999 9999" - }, - "cardCodeRegex": { - "type": "string", - "description": "Card code regular expression.", - "example": "[^0-9]" - }, - "cardCodeMask": { - "type": "string", - "description": "Card code mask.", - "example": "999" - }, - "weights": { - "type": "array", - "description": "Weights.", - "items": { - "type": "integer" - }, - "default": [ - 2, - 1, - 2, - 1, - 2, - 1, - 2, - 1, - 2, - 1, - 2, - 1, - 2, - 1, - 2, - 1, - 2, - 1, - 2 - ] - } - } - }, - "stringId": { - "type": "string", - "description": "String ID.", - "default": "12345abc" - }, - "template": { - "type": "string", - "description": "Template.", - "default": "creditCardPaymentGroup-template" - }, - "requiresDocument": { - "type": "boolean", - "description": "Indicates whether a document is required.", - "default": false - }, - "selected": { - "type": "boolean", - "description": "Indicates whether this payment system has been selected.", - "default": false - }, - "isCustom": { - "type": "boolean", - "description": "Indicates whether it is custom.", - "default": false - }, - "description": { - "type": "string", - "description": "Description.", - "default": "description-example" - } - } - } - }, - "payments": { - "type": "array", - "description": "Payment information.", - "items": { - "type": "object", - "required": [ - "paymentSystem", - "referenceValue", - "value", - "installments" - ], - "description": "", - "properties": { - "accountId": { - "type": "string", - "description": "Account ID.", - "default": "accountID-example" - }, - "bin": { - "type": "string", - "description": "Payment bin.", - "default": "2" - }, - "installments": { - "type": "integer", - "description": "Number of installments.", - "default": 2 - }, - "paymentSystem": { - "type": "string", - "description": "Payment system.", - "default": "12" - }, - "referenceValue": { - "type": "integer", - "description": "Reference value for calculating interest rates, in case it applies.", - "default": 16175 - }, - "value": { - "type": "integer", - "description": "Value including interest, in case it applies.", - "default": 16175 - } - } - } - }, - "updateStatus": { - "type": "string", - "description": "Indicates whether this object's information is up to date according to the order's items. An order can not be placed if `\"outdated\"`", - "default": "updated" - } - } - }, - "marketingData": { - "type": "object", - "properties": { - "coupon": { - "type": "string", - "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.", - "default": "free-shipping" - }, - "utmSource": { - "type": "string", - "description": "UTM source.", - "default": "Facebook" - }, - "utmMedium": { - "type": "string", - "description": "UTM medium.", - "default": "CPC" - }, - "utmCampaign": { - "type": "string", - "description": "UTM campaign", - "default": "Black friday" - }, - "utmiPage": { - "type": "string", - "description": "utmi_page (internal utm)", - "default": "utmi_page-example" - }, - "utmiPart": { - "type": "string", - "description": "utmi_part (internal utm)", - "default": "utmi_part-exmaple" - }, - "utmiCampaign": { - "type": "string", - "description": "utmi_campaign (internal utm)", - "default": "utmi_campaign-exmaple" - } - } - }, - "openTextField": { - "type": "string", - "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1)", - "default": "open-text-example" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "orderForm": { - "type": "string", - "description": "This is `null` since this request does not depend on any previously existing orderForm information in the platform.", - "nullable": true - }, - "transactionData": { - "type": "object", - "description": "Information on each transaction pertinent to the order placed.", - "properties": { - "merchantTransactions": { - "type": "array", - "description": "Information on each merchant transaction.", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ID of the seller." - }, - "transactionId": { - "type": "string", - "description": "ID of the transaction in the platform." - }, - "merchantName": { - "type": "string", - "description": "Name of the merchant responsible for the sale." - }, - "payments": { - "type": "array", - "description": "Information on each payment pertinent to the transaction.", - "items": { - "type": "object", - "properties": { - "paymentSystem": { - "type": "string", - "description": "Payment system." - }, - "bin": { - "type": "string", - "description": "Payment bin.", - "nullable": true - }, - "accountId": { - "type": "string", - "description": "Account ID.", - "nullable": true - }, - "tokenId": { - "type": "string", - "description": "Token ID.", - "nullable": true - }, - "value": { - "type": "integer", - "description": "Total value to be paid in this payment." - }, - "referenceValue": { - "type": "integer", - "description": "Reference value over which interests may be applied." - }, - "giftCardRedemptionCode": { - "type": "string", - "description": "Gift card redemption code.", - "nullable": true - }, - "giftCardProvider": { - "type": "string", - "description": "Gift card provider.", - "nullable": true - }, - "giftCardId": { - "type": "string", - "description": "Gift card ID.", - "nullable": true - } - } - } - } - } - } - }, - "receiverUri": { - "type": "string", - "description": "Receiver URI." - }, - "gatewayCallbackTemplatePath": { - "type": "string", - "description": "Template of the gateway callback path, which may later be used to send information about the transaction." - } - } - }, - "orders": { - "type": "array", - "description": "Information on each of the orders created.", - "items": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "ID of the order in the Order Management System (OMS)." - }, - "orderGroup": { - "type": "string", - "description": "Order group. Orders that involve different sellers are split into different orders of a same order group." - }, - "state": { - "type": "string", - "description": "State.", - "nullable": true - }, - "isCheckedIn": { - "type": "boolean", - "description": "Indicates whether order is checked in.", - "default": false - }, - "sellerOrderId": { - "type": "string", - "description": "ID of the order in the seller.", - "nullable": true - }, - "storeId": { - "type": "string", - "description": "Store ID.", - "nullable": true - }, - "checkedInPickupPointId": { - "type": "string", - "description": "Checked in pickuppoint.", - "nullable": true - }, - "value": { - "type": "integer", - "description": "Value of the order." - }, - "items": { - "type": "array", - "description": "Information on each item in the order.", - "items": { - "type": "object", - "properties": { - "uniqueId": { - "type": "string", - "description": "Unique ID." - }, - "id": { - "type": "string", - "description": "ID of the item." - }, - "productId": { - "type": "string", - "description": "Product ID." - }, - "productRefId": { - "type": "string", - "description": "Product Ref ID." - }, - "refId": { - "type": "string", - "description": "Ref ID." - }, - "ean": { - "type": "string", - "description": "European Article Number.", - "nullable": true - }, - "name": { - "type": "string", - "description": "Product name." - }, - "skuName": { - "type": "string", - "description": "SKU name." - }, - "modalType": { - "type": "string", - "description": "Modal type.", - "nullable": true - }, - "parentItemIndex": { - "type": "integer", - "description": "Parent item index.", - "nullable": true - }, - "parentAssemblyBinding": { - "type": "string", - "description": "Parent assembly binding.", - "nullable": true - }, - "priceValidUntil": { - "type": "string", - "description": "Price expiration date and time." - }, - "tax": { - "type": "integer", - "description": "Tax value in cents." - }, - "price": { - "type": "integer", - "description": "Price in cents." - }, - "listPrice": { - "type": "integer", - "description": "List price in cents." - }, - "manualPrice": { - "type": "integer", - "description": "Manual price in cents.", - "nullable": true - }, - "manualPriceAppliedBy": { - "type": "string", - "description": "User that applied the manual price, if that is the case.", - "nullable": true - }, - "sellingPrice": { - "type": "integer", - "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead." - }, - "rewardValue": { - "type": "integer", - "description": "Reward value in cents." - }, - "isGift": { - "type": "boolean", - "description": "Indicates whether item is a gift." - }, - "additionalInfo": { - "type": "object", - "description": "Additional information.", - "properties": { - "dimension": { - "type": "string", - "description": "Dimension.", - "nullable": true - }, - "brandName": { - "type": "string", - "description": "Brand name." - }, - "brandId": { - "type": "string", - "description": "Brand ID." - }, - "offeringInfo": { - "type": "string", - "description": "Offering information.", - "nullable": true - }, - "offeringType": { - "type": "string", - "description": "Offering type.", - "nullable": true - }, - "offeringTypeId": { - "type": "string", - "description": "Offering type ID.", - "nullable": true - } - } - }, - "preSaleDate": { - "type": "string", - "description": "Presale date.", - "nullable": true - }, - "productCategoryIds": { - "type": "string", - "description": "Product category IDs." - }, - "productCategories": { - "type": "object", - "description": "Object, where each field is an ID from `productCategoryIds`.", - "properties": { - "{ID}": { - "type": "string", - "description": "Product category corresponding to the ID in the field key." - } - } - }, - "quantity": { - "type": "integer", - "description": "Quantity." - }, - "seller": { - "type": "string", - "description": "Seller." - }, - "sellerChain": { - "type": "array", - "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/pt/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.", - "items": { - "type": "string", - "description": "Seller." - } - }, - "imageUrl": { - "type": "string", - "description": "Image URL." - }, - "detailUrl": { - "type": "string", - "description": "Detail URL." - }, - "bundleItems": { - "type": "array", - "description": "Information on services sold along with the SKU. Example: a gift package.", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Service type." - }, - "id": { - "type": "integer", - "description": "Service identifier." - }, - "name": { - "type": "string", - "description": "Service name." - }, - "price": { - "type": "integer", - "description": "Service price in cents." - } - } - } - }, - "attachments": { - "type": "array", - "description": "Array containing information on attachments.", - "items": { - "type": "string" - } - }, - "priceTags": { - "type": "array", - "description": "Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order.", - "items": { - "type": "object", - "properties": { - "identifier": { - "type": "string", - "description": "Price tag identifier." - }, - "isPercentual": { - "type": "boolean", - "description": "Indicates whether price tag value is applied through a percentage." - }, - "name": { - "type": "string", - "description": "Price tag name." - }, - "rawValue": { - "type": "integer", - "description": "Price tag raw value." - }, - "value": { - "type": "integer", - "description": "Price tag value." - } - } - } - }, - "availability": { - "type": "string", - "description": "Availability" - }, - "measurementUnit": { - "type": "string", - "description": "Measurement unit" - }, - "unitMultiplier": { - "type": "integer", - "description": "Unit multiplier" - }, - "manufacturerCode": { - "type": "string", - "description": "Manufacturer code.", - "nullable": true - }, - "priceDefinition": { - "type": "object", - "description": "Price information for all units of a specific item.", - "properties": { - "calculatedSellingPrice": { - "type": "integer", - "description": "Item's calculated unitary selling price in cents." - }, - "total": { - "type": "integer", - "description": "Total value for all units of the item in cents." - }, - "sellingPrices": { - "type": "array", - "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.", - "items": { - "type": "object", - "properties": { - "value": { - "type": "integer", - "description": "Value in cents for that specific rounding." - }, - "quantity": { - "type": "integer", - "description": "Rounding quantity, meaning how many items are rounded to this value." - } - } - } - } - } - } - } - } - }, - "sellers": { - "type": "array", - "description": "Information on each seller.", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Seller ID." - }, - "name": { - "type": "string", - "description": "Seller name." - }, - "logo": { - "type": "string", - "description": "Seller logo.", - "nullable": true - } - } - } - }, - "totals": { - "type": "array", - "description": "Information on order totals.", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Total ID." - }, - "name": { - "type": "string", - "description": "Total name." - }, - "value": { - "type": "integer", - "description": "Total value." - } - } - } - }, - "clientProfileData": { - "type": "object", - "description": "Customer's profile information.", - "properties": { - "email": { - "type": "string", - "description": "Email address." - }, - "firstName": { - "type": "string", - "description": "First name." - }, - "lastName": { - "type": "string", - "description": "Last name." - }, - "documentType": { - "type": "string", - "description": "Type of the document informed by the customer." - }, - "document": { - "type": "string", - "description": "Document informed by the customer." - }, - "phone": { - "type": "string", - "description": "Phone number." - }, - "corporateName": { - "type": "string", - "description": "Company name, if the customer is a legal entity.", - "nullable": true - }, - "tradeName": { - "type": "string", - "description": "Trade name, if the customer is a legal entity.", - "nullable": true - }, - "corporateDocument": { - "type": "string", - "description": "Corporate document, if the customer is a legal entity.", - "nullable": true - }, - "stateInscription": { - "type": "string", - "description": "State inscription, if the customer is a legal entity.", - "nullable": true - }, - "corporatePhone": { - "type": "string", - "description": "Corporate phone number, if the customer is a legal entity.", - "nullable": true - }, - "isCorporate": { - "type": "boolean", - "description": "Indicates whether the customer is a legal entity." - }, - "profileCompleteOnLoading": { - "type": "boolean", - "description": "Indicates whether profile is complete on loading." - }, - "profileErrorOnLoading": { - "type": "boolean", - "description": "Indicates whether profile presents error on loading.", - "nullable": true - }, - "customerClass": { - "type": "string", - "description": "Customer class.", - "nullable": true - } - } - }, - "ratesAndBenefitsData": { - "type": "object", - "description": "Information on rates and benefits that apply to the order.", - "properties": { - "rateAndBenefitsIdentifiers": { - "type": "array", - "description": "List with rates and benefits identifiers.", - "items": { - "type": "string" - } - }, - "teaser": { - "type": "array", - "description": "List with rates and benefits teasers.", - "items": { - "type": "string" - } - } - } - }, - "shippingData": { - "type": "object", - "description": "Shipping information pertinent to the order.", - "properties": { - "address": { - "type": "object", - "description": "Address information.", - "properties": { - "addressType": { - "type": "string", - "description": "Type of address. For example, `Residential` or `Pickup`." - }, - "receiverName": { - "type": "string", - "description": "Name of the person who is going to receive the order." - }, - "addressId": { - "type": "string", - "description": "Address ID." - }, - "isDisposable": { - "type": "boolean", - "description": "Indicates whether address is disposable." - }, - "postalCode": { - "type": "string", - "description": "Postal code." - }, - "city": { - "type": "string", - "description": "City of the shipping address." - }, - "state": { - "type": "string", - "description": "State of the shipping address." - }, - "country": { - "type": "string", - "description": "Three letter ISO code of the country of the shipping address." - }, - "street": { - "type": "string", - "description": "Street of the shipping address." - }, - "number": { - "type": "string", - "description": "Number of the building, house or apartment in the shipping address." - }, - "neighborhood": { - "type": "string", - "description": "Neighborhood of the shipping address." - }, - "complement": { - "type": "string", - "description": "Complement to the shipping address, in case it applies.", - "nullable": true - }, - "reference": { - "type": "string", - "description": "Complement that might help locate the shipping address more precisely in case of delivery.", - "nullable": true - }, - "geoCoordinates": { - "type": "array", - "description": "Array with two strings with geocoordinates, first latitude, then longitude.", - "items": { - "type": "string" - } - } - } - }, - "logisticsInfo": { - "type": "array", - "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.", - "items": { - "type": "object", - "properties": { - "itemIndex": { - "type": "integer", - "description": "Index corresponding to the position of the object in the `items` array." - }, - "selectedSla": { - "type": "string", - "description": "SLA selected by the customer." - }, - "selectedDeliveryChannel": { - "type": "string", - "description": "Delivery channel selected by the customer." - }, - "addressId": { - "type": "string", - "description": "Address ID." - }, - "slas": { - "type": "array", - "description": "Information on available SLAs.", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "SLA ID." - }, - "deliveryChannel": { - "type": "string", - "description": "Delivery channel." - }, - "name": { - "type": "string", - "description": "SLA name." - }, - "deliveryIds": { - "type": "array", - "description": "Information on each delivery ID.", - "items": { - "type": "object", - "properties": { - "courierId": { - "type": "string", - "description": "Courier ID." - }, - "warehouseId": { - "type": "string", - "description": "Warehouse ID." - }, - "dockId": { - "type": "string", - "description": "Warehouse ID." - }, - "courierName": { - "type": "string", - "description": "Courier name." - }, - "quantity": { - "type": "integer", - "description": "Quantity." - } - } - } - }, - "shippingEstimate": { - "type": "string", - "description": "Shipping estimate. For instance, Three business days will be represented `3bd`." - }, - "shippingEstimateDate": { - "type": "string", - "description": "Shipping estimate date.", - "nullable": true - }, - "lockTTL": { - "type": "string", - "description": "Estimate date of delivery." - }, - "price": { - "type": "integer", - "description": "Price in cents." - }, - "listPrice": { - "type": "integer", - "description": "List price in cents." - }, - "tax": { - "type": "integer", - "description": "Tax in cents." - }, - "pickupStoreInfo": { - "type": "object", - "description": "Information on the pickup store.", - "properties": { - "isPickupStore": { - "type": "boolean", - "description": "Indicates whether it is the pickup store." - }, - "friendlyName": { - "type": "string", - "description": "Friendly name.", - "nullable": true - }, - "address": { - "type": "object", - "description": "Address information.", - "nullable": true, - "properties": { - "addressType": { - "type": "string", - "description": "Type of address. For example, `Residential` or `Pickup`." - }, - "postalCode": { - "type": "string", - "description": "Postal code." - }, - "city": { - "type": "string", - "description": "City of the shipping address." - }, - "state": { - "type": "string", - "description": "State of the shipping address." - }, - "country": { - "type": "string", - "description": "Three letter ISO code of the country of the shipping address." - }, - "street": { - "type": "string", - "description": "Street of the shipping address." - }, - "number": { - "type": "string", - "description": "Number of the building, house or apartment in the shipping address." - }, - "neighborhood": { - "type": "string", - "description": "Neighborhood of the shipping address." - }, - "complement": { - "type": "string", - "description": "Complement to the shipping address, in case it applies.", - "nullable": true - }, - "reference": { - "type": "string", - "description": "Complement that might help locate the shipping address more precisely in case of delivery.", - "nullable": true - }, - "geoCoordinates": { - "type": "array", - "description": "Array with two strings with geocoordinates, first latitude, then longitude.", - "items": { - "type": "string" - } - } - } - }, - "additionalInfo": { - "type": "string", - "description": "Additional information.", - "nullable": true - }, - "dockId": { - "type": "string", - "description": "Corresponding dock ID.", - "nullable": true - } - } - }, - "pickupPointId": { - "type": "string", - "description": "Pickup point ID.", - "nullable": true - }, - "pickupDistance": { - "type": "integer", - "description": "Pickup point distance." - }, - "polygonName": { - "type": "string", - "description": "Polygon name.", - "nullable": true - }, - "transitTime": { - "type": "string", - "description": "Transit time. For instance, \"three business days\" is represented `3bd`." - } - } - } - }, - "shipsTo": { - "type": "array", - "description": "List of countries that the item may be shipped to.", - "items": { - "type": "string", - "description": "Three letter country code." - } - }, - "itemId": { - "type": "string", - "description": "Item ID." - }, - "deliveryChannels": { - "type": "array", - "description": "List of available delivery channels.", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Delivery channel ID." - } - } - } - } - } - } - }, - "selectedAddresses": { - "type": "array", - "description": "Array with information on the selected addresses for the order.", - "items": { - "type": "object", - "properties": { - "addressType": { - "type": "string", - "description": "Type of address. For example, `Residential` or `Pickup`." - }, - "receiverName": { - "type": "string", - "description": "Name of the person who is going to receive the order." - }, - "addressId": { - "type": "string", - "description": "Address ID." - }, - "isDisposable": { - "type": "boolean", - "description": "Indicates whether address is disposable." - }, - "postalCode": { - "type": "string", - "description": "Postal code." - }, - "city": { - "type": "string", - "description": "City of the shipping address." - }, - "state": { - "type": "string", - "description": "State of the shipping address." - }, - "country": { - "type": "string", - "description": "Three letter ISO code of the country of the shipping address." - }, - "street": { - "type": "string", - "description": "Street of the shipping address." - }, - "number": { - "type": "string", - "description": "Number of the building, house or apartment in the shipping address." - }, - "neighborhood": { - "type": "string", - "description": "Neighborhood of the shipping address." - }, - "complement": { - "type": "string", - "description": "Complement to the shipping address, in case it applies." - }, - "reference": { - "type": "string", - "description": "Complement that might help locate the shipping address more precisely in case of delivery.", - "nullable": true - }, - "geoCoordinates": { - "type": "array", - "description": "Array with two strings with geocoordinates, first latitude, then longitude.", - "items": { - "type": "string" - } - } - } - } - }, - "availableAddresses": { - "type": "array", - "description": "Array with information on the available addresses for the order.", - "items": { - "type": "object", - "properties": { - "addressType": { - "type": "string", - "description": "Type of address. For example, `Residential` or `Pickup`." - }, - "receiverName": { - "type": "string", - "description": "Name of the person who is going to receive the order." - }, - "addressId": { - "type": "string", - "description": "Address ID." - }, - "isDisposable": { - "type": "boolean", - "description": "Indicates whether address is disposable." - }, - "postalCode": { - "type": "string", - "description": "Postal code." - }, - "city": { - "type": "string", - "description": "City of the shipping address." - }, - "state": { - "type": "string", - "description": "State of the shipping address." - }, - "country": { - "type": "string", - "description": "Three letter ISO code of the country of the shipping address." - }, - "street": { - "type": "string", - "description": "Street of the shipping address." - }, - "number": { - "type": "string", - "description": "Number of the building, house or apartment in the shipping address." - }, - "neighborhood": { - "type": "string", - "description": "Neighborhood of the shipping address." - }, - "complement": { - "type": "string", - "description": "Complement to the shipping address, in case it applies." - }, - "reference": { - "type": "string", - "description": "Complement that might help locate the shipping address more precisely in case of delivery.", - "nullable": true - }, - "geoCoordinates": { - "type": "array", - "description": "Array with two strings with geocoordinates, first latitude, then longitude.", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "paymentData": { - "type": "object", - "description": "Information on the order's payment.", - "properties": { - "giftCards": { - "type": "array", - "description": "Gift card information, if it applies to the order.", - "items": { - "type": "object", - "properties": { - "redemptionCode": { - "type": "string", - "description": "Gift card redemption code." - }, - "value": { - "type": "integer", - "description": "Gift card value in cents." - }, - "balance": { - "type": "integer", - "description": "Gift card balance in cents." - }, - "name": { - "type": "string", - "description": "Gift card name." - }, - "id": { - "type": "string", - "description": "Gift card ID." - }, - "inUse": { - "type": "boolean", - "description": "Indicates whether gift card is in use." - }, - "isSpecialCard": { - "type": "boolean", - "description": "Indicates whether gift card is special." - } - } - } - }, - "transactions": { - "type": "array", - "description": "Information on each transaction pertinent to the order.", - "items": { - "type": "object", - "properties": { - "isActive": { - "type": "boolean", - "description": "Indicates whether transaction is active." - }, - "transactionId": { - "type": "string", - "description": "Transaction ID." - }, - "merchantName": { - "type": "string", - "description": "Merchant name." - }, - "payments": { - "type": "array", - "description": "Information on each payment.", - "items": { - "type": "object", - "properties": { - "accountId": { - "type": "string", - "description": "Account ID." - }, - "bin": { - "type": "string", - "description": "Bin." - }, - "installments": { - "type": "integer", - "description": "Number of installments." - }, - "paymentSystem": { - "type": "string", - "description": "Payment system." - }, - "referenceValue": { - "type": "integer", - "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents." - }, - "value": { - "type": "integer", - "description": "Value including interest, in case it applies. Displayed in cents." - } - } - } - }, - "sharedTransaction": { - "type": "boolean", - "description": "Indicates whather transaction is shared." - } - } - } - } - } - }, - "itemMetadata": { - "type": "object", - "description": "Item metadata.", - "properties": { - "items": { - "type": "array", - "description": "List of objects containing metadata on each item in the order.", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Item ID." - }, - "seller": { - "type": "string", - "description": "Seller." - }, - "name": { - "type": "string", - "description": "Product name." - }, - "skuName": { - "type": "string", - "description": "SKU name." - }, - "productId": { - "type": "string", - "description": "Product ID." - }, - "refId": { - "type": "string", - "description": "Ref ID." - }, - "ean": { - "type": "string", - "description": "European Article Number.", - "nullable": true - }, - "imageUrl": { - "type": "string", - "description": "Image URL." - }, - "detailUrl": { - "type": "string", - "description": "Detail URL." - } - } - } - } - } - }, - "salesChannel": { - "type": "string", - "description": "Sales channel." - }, - "followUpEmail": { - "type": "string", - "description": "Follow up email address." - }, - "creationDate": { - "type": "string", - "description": "Creation date." - }, - "lastChange": { - "type": "string", - "description": "Last change." - }, - "timeZoneCreationDate": { - "type": "string", - "description": "Time zone creation date." - }, - "timeZoneLastChange": { - "type": "string", - "description": "Time zone last change." - }, - "isCompleted": { - "type": "boolean", - "description": "Indicates whether order is completed." - }, - "hostName": { - "type": "string", - "description": "Host name." - }, - "merchantName": { - "type": "string", - "description": "Merchant name.", - "nullable": true - }, - "userType": { - "type": "string", - "description": "User type." - }, - "roundingError": { - "type": "integer", - "description": "Rounding error." - }, - "allowEdition": { - "type": "boolean", - "description": "Indicates whether edition is allowed." - }, - "allowCancelation": { - "type": "boolean", - "description": "Indicates whether cancelation is allowed." - }, - "allowChangeSeller": { - "type": "boolean", - "description": "Indicates whether seller changing is allowed." - }, - "isUserDataVisible": { - "type": "boolean", - "description": "Indicates whether user data is visible." - }, - "orderFormCreationDate": { - "type": "string", - "description": "`orderForm` creation date." - } - } - } - } - } - }, - "example": { - "orderForm": null, - "transactionData": { - "merchantTransactions": [ - { - "id": "MYSTORE", - "transactionId": "296D6D245C17437E823EB77E403FC88D", - "merchantName": "MYSTORE", - "payments": [ - { - "paymentSystem": "6", - "bin": null, - "accountId": null, - "tokenId": null, - "value": 34390, - "referenceValue": 34390, - "giftCardRedemptionCode": null, - "giftCardProvider": null, - "giftCardId": null - } - ] - } - ], - "receiverUri": "https://mystore.vtexpayments.com.br/split/1146512005522/payments", - "gatewayCallbackTemplatePath": "/checkout/gatewayCallback/1146512005522/{messageCode}" - }, - "orders": [ - { - "orderId": "1146512005522-01", - "orderGroup": "1146512005522", - "state": null, - "isCheckedIn": false, - "sellerOrderId": "00-1146512005522-01", - "storeId": null, - "checkedInPickupPointId": null, - "value": 34390, - "items": [ - { - "uniqueId": "9D6E447B3FF64CEDA33B17C01379C119", - "id": "2", - "productId": "2", - "productRefId": "", - "refId": "CBC30L", - "ean": null, - "name": "Chopp Brahma Claro 30L", - "skuName": "Chopp Brahma Claro 30L", - "modalType": null, - "parentItemIndex": null, - "parentAssemblyBinding": null, - "assemblies": [], - "priceValidUntil": "2022-07-13T18:30:46Z", - "tax": 0, - "price": 32890, - "listPrice": 49900, - "manualPrice": null, - "manualPriceAppliedBy": null, - "sellingPrice": 32890, - "rewardValue": 0, - "isGift": false, - "additionalInfo": { - "dimension": null, - "brandName": "Brahma", - "brandId": "2000000", - "offeringInfo": null, - "offeringType": null, - "offeringTypeId": null - }, - "preSaleDate": null, - "productCategoryIds": "/1/", - "productCategories": { - "1": "Bebidas" - }, - "quantity": 1, - "seller": "1", - "sellerChain": [ - "1" - ], - "imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000", - "detailUrl": "/chopp-brahma-claro-30l/p", - "components": [], - "bundleItems": [], - "attachments": [], - "attachmentOfferings": [], - "offerings": [], - "priceTags": [], - "availability": "available", - "measurementUnit": "un", - "unitMultiplier": 1, - "manufacturerCode": null, - "priceDefinition": { - "calculatedSellingPrice": 32890, - "total": 32890, - "sellingPrices": [ - { - "value": 32890, - "quantity": 1 - } - ] - } - } - ], - "sellers": [ - { - "id": "1", - "name": "Tracking QA", - "logo": "" - } - ], - "totals": [ - { - "id": "Items", - "name": "Total dos Itens", - "value": 32890 - }, - { - "id": "Discounts", - "name": "Total dos Descontos", - "value": 0 - }, - { - "id": "Shipping", - "name": "Total do Frete", - "value": 1500 - }, - { - "id": "Tax", - "name": "Total da Taxa", - "value": 0 - } - ], - "clientProfileData": { - "email": "clark.kent@example.com", - "firstName": "Clark", - "lastName": "Kent", - "document": "12345678900", - "documentType": "cpf", - "phone": "+5521998765432", - "corporateName": null, - "tradeName": null, - "corporateDocument": null, - "stateInscription": null, - "corporatePhone": null, - "isCorporate": false, - "profileCompleteOnLoading": false, - "profileErrorOnLoading": null, - "customerClass": null - }, - "ratesAndBenefitsData": { - "rateAndBenefitsIdentifiers": [], - "teaser": [] - }, - "shippingData": { - "address": { - "addressType": "residential", - "receiverName": "Clark Kent", - "addressId": "teste", - "isDisposable": true, - "postalCode": "70386000", - "city": "Brasília", - "state": "DF", - "country": "BRA", - "street": "Rua da minha casa", - "number": "123", - "neighborhood": "Copacabana", - "complement": "15º andar", - "reference": null, - "geoCoordinates": [ - "-47.924747467041016", - "-15.832582473754883" - ] - }, - "logisticsInfo": [ - { - "itemIndex": 0, - "selectedSla": "Normal", - "selectedDeliveryChannel": "delivery", - "addressId": "teste", - "slas": [ - { - "id": "Normal", - "deliveryChannel": "delivery", - "name": "Normal", - "deliveryIds": [ - { - "courierId": "1", - "warehouseId": "1_1", - "dockId": "1", - "courierName": "Transportadora", - "quantity": 1, - "kitItemDetails": [] - } - ], - "shippingEstimate": "3bd", - "shippingEstimateDate": null, - "lockTTL": "10d", - "availableDeliveryWindows": [], - "deliveryWindow": null, - "price": 1500, - "listPrice": 1500, - "tax": 0, - "pickupStoreInfo": { - "isPickupStore": false, - "friendlyName": null, - "address": null, - "additionalInfo": null, - "dockId": null - }, - "pickupPointId": null, - "pickupDistance": 0, - "polygonName": null, - "transitTime": "3bd" - } - ], - "shipsTo": [ - "BRA", - "COL", - "USA" - ], - "itemId": "2", - "deliveryChannels": [ - { - "id": "delivery" - }, - { - "id": "pickup-in-point" - } - ] - } - ], - "selectedAddresses": [ - { - "addressType": "residential", - "receiverName": "Clark Kent", - "addressId": "teste", - "isDisposable": true, - "postalCode": "12345000", - "city": "Rio de Janeiro", - "state": "RJ", - "country": "BRA", - "street": "Rua da minha casa", - "number": "123", - "neighborhood": "Copacabana", - "complement": "15º andar", - "reference": null, - "geoCoordinates": [ - "-47.924747467041016", - "-15.832582473754883" - ] - } - ], - "availableAddresses": [ - { - "addressType": "residential", - "receiverName": "Clark Kent", - "addressId": "teste", - "isDisposable": true, - "postalCode": "12345000", - "city": "Rio de Janeiro", - "state": "RJ", - "country": "BRA", - "street": "Rua da minha casa", - "number": "123", - "neighborhood": "Copacabana", - "complement": "15º andar", - "reference": null, - "geoCoordinates": [ - "-47.924747467041016", - "-15.832582473754883" - ] - } - ], - "pickupPoints": [] - }, - "paymentData": { - "giftCards": [], - "transactions": [ - { - "isActive": true, - "transactionId": "296D6D245C17437E823EB77E403FC88D", - "merchantName": "MYSTORE", - "payments": [], - "sharedTransaction": false - } - ] - }, - "clientPreferencesData": null, - "commercialConditionData": null, - "giftRegistryData": null, - "marketingData": null, - "storePreferencesData": { - "countryCode": "BRA", - "saveUserData": false, - "timeZone": "E. South America Standard Time", - "currencyCode": "BRL", - "currencyLocale": 1046, - "currencySymbol": "R$", - "currencyFormatInfo": { - "currencyDecimalDigits": 2, - "currencyDecimalSeparator": ",", - "currencyGroupSeparator": ".", - "currencyGroupSize": 3, - "startsWithCurrencySymbol": true - } - }, - "openTextField": { - "value": null - }, - "invoiceData": null, - "itemMetadata": { - "items": [ - { - "id": "2", - "seller": "1", - "name": "Chopp Brahma Claro 30L", - "skuName": "Chopp Brahma Claro 30L", - "productId": "2", - "refId": "CBC30L", - "ean": null, - "imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000", - "detailUrl": "/chopp-brahma-claro-30l/p", - "assemblyOptions": [] - } - ] - }, - "taxData": null, - "customData": null, - "hooksData": null, - "changeData": null, - "subscriptionData": null, - "salesChannel": "1", - "followUpEmail": "6c10d76b5170456d89823b38b7c8f6ac@ct.vtex.com.br", - "creationDate": "2021-07-13T18:33:25.3029443Z", - "lastChange": "2021-07-13T18:33:27.736557Z", - "timeZoneCreationDate": "2021-07-13T15:33:25.3029443", - "timeZoneLastChange": "2021-07-13T15:33:27.736557", - "isCompleted": false, - "hostName": "mystore", - "merchantName": null, - "userType": "", - "roundingError": 0, - "allowEdition": false, - "allowCancellation": false, - "isUserDataVisible": true, - "allowChangeSeller": false, - "orderFormCreationDate": "2021-07-13T18:33:25.1313373Z" - } - ] - } - } - } - } - }, - "deprecated": false - } - }, - "/api/checkout/pub/gatewayCallback/{orderGroup}": { - "post": { - "tags": [ - "Order placement" - ], - "summary": "Process order", - "description": "Order processing callback request, which is made after an order's payment is approved.\n\r\n\r> This request has to be made until five minutes after the [Place order](https://developers.vtex.com/vtex-rest-api/reference/order-placement-1#placeorder) or [Place order from existing cart](https://developers.vtex.com/vtex-rest-api/reference/order-placement-1#placeorderfromexistingorderform) request has beem made, or else, the order will not be processed.", - "operationId": "ProcessOrder", - "parameters": [ - { - "name": "orderGroup", - "in": "path", - "description": "Order group. It is the part of the `orderId` that comes before the `-`. For example, the `orderGroup` of the order `123456789-01` is `123456789`.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "123456789" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Cookie", - "in": "header", - "description": "VTEX Chekout cookie associated with a specific order. Use the `Vtex_CHKO_Auth` and the `CheckoutDataAccess` cookies returned by the [Place order](https://developers.vtex.com/vtex-rest-api/reference/order-placement-1#placeorder) or [Place order from existing cart](https://developers.vtex.com/vtex-rest-api/reference/order-placement-1#placeorderfromexistingorderform) API requests, like a browser would.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "Vtex_CHKO_Auth=0e/RpYIEZu19BuwXB4tZ7eIGu9HT8vdUAHWQDHDpxMc=; CheckoutDataAccess=0e/PoiTEZu19BuwXB4tZ7eIGu9HT8vdUAHWQDHDpxMc=" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "example": {} - } - } - }, - "500": { - "description": "Internal Server Error", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "operationId": { - "type": "string", - "description": "Operation ID." - }, - "error": { - "type": "object", - "description": "Information on the error.", - "properties": { - "code": { - "type": "string", - "description": "Error code." - }, - "message": { - "type": "string", - "description": "Error message." - }, - "exception": { - "type": "string", - "description": "Error exception.", - "nullable": true - } - } - } - } - }, - "example": { - "operationId": "a231ed11-255b-4ea0-96c3-1790e1b27f7e", - "error": { - "code": "001", - "message": "Seu pagamento não foi autorizado. Falha ao enviar os dados de pagamento. Favor entrar em contato com o SAC ou utilizar outra forma de pagamento. *** ", - "exception": null - } - } - } - } - } - }, - "deprecated": false - } - }, - "/api/checkout/pub/regions/{regionId}": { - "get": { - "tags": [ - "Region" - ], - "summary": "Get sellers by region", - "description": "Retrieve a list of sellers that cater to a specific region, according to your set up of our [regionalization feature](https://help.vtex.com/en/tutorial/setting-up-price-and-availability-of-skus-by-region--12ne58BmvYsYuGsimmugoc#). Learn more about [Region v2](https://developers.vtex.com/vtex-developer-docs/changelog/region-v2).", - "operationId": "GetSellersByRegion", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "Type of the content being sent.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "regionId", - "in": "path", - "description": "ID of the region corresponding to the shopper's location.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "store12" - } - }, - { - "name": "country", - "in": "query", - "description": "Three letter country code according to [ISO 3166-1 alpha 3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).", - "required": false, - "style": "form", - "schema": { - "type": "string", - "example": "BRA" - } - }, - { - "name": "postalCode", - "in": "query", - "description": "Postal code.", - "required": false, - "style": "form", - "schema": { - "type": "string", - "example": "12345000" - } - }, - { - "name": "sc", - "in": "query", - "description": "Sales channel ID.", - "required": false, - "style": "form", - "schema": { - "type": "string", - "example": "1" - } - }, - { - "name": "desiredSellerType", - "in": "query", - "description": "Desired seller type. Possible values are: `\"All\"`, `\"Default\"` or `\"Whitelabel\"`, which is the default.", - "required": false, - "style": "form", - "schema": { - "type": "string", - "example": "1", - "default": "Whitelabel" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Region ID." - }, - "sellers": { - "type": "array", - "description": "Array with information on each seller retrieved for the given region.", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Seller ID." - }, - "name": { - "type": "string", - "description": "Seller name." - }, - "logo": { - "type": "string", - "description": "Seller logo.", - "nullable": true - } - } - } - } - } - }, - "example": { - "id": "v2.1C5AA851749C8365E170CE5AF629AB6E", - "sellers": [ - { - "id": "abacaba", - "name": "Abacaba Store", - "logo": null - }, - { - "id": "abacaba2", - "name": "Abacaba VTEX Outlet", - "logo": null - }, - { - "id": "abacaba3", - "name": "Abacaba VTEX Mall", - "logo": null - } - ] - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "OrderFormSimulationRequest": { - "required": [ - "items", - "country" - ], - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Item" - }, - "description": "Array containing information about the SKUs inside the cart to be simulated." - }, - "country": { - "type": "string" - } - }, - "example": { - "items": [ - { - "id": "{{skuId}}", - "quantity": 1, - "seller": "1" - } - ], - "country": "{{countryCode-ISO-3-digits}}" - } - }, - "Item": { - "title": "Item", - "required": [ - "id", - "quantity", - "seller" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The SKU ID." - }, - "quantity": { - "type": "integer", - "format": "int32", - "description": "The quantity of items of this specific SKU in the cart to be simulated." - }, - "seller": { - "type": "string", - "description": "The ID of the seller responsible for this SKU. This ID can be found in your VTEX Admin." - } - }, - "example": { - "id": "{{skuId}}", - "quantity": 1, - "seller": "1" - } - }, - "PriceChangeRequest": { - "required": [ - "price" - ], - "type": "object", - "properties": { - "price": { - "type": "integer", - "format": "int32", - "description": "The new price of the item." - } - }, - "example": { - "price": 10000 - } - }, - "SetsinglecustomfieldvalueRequest": { - "required": [ - "value" - ], - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "The value you want to set to the specified field." - } - } - }, - "UpdateorderFormconfigurationRequest": { - "required": [ - "paymentConfiguration", - "taxConfiguration", - "minimumQuantityAccumulatedForItems", - "decimalDigitsPrecision", - "minimumValueAccumulated", - "apps", - "allowMultipleDeliveries", - "allowManualPrice" - ], - "type": "object", - "properties": { - "paymentConfiguration": { - "$ref": "#/components/schemas/PaymentConfiguration" - }, - "taxConfiguration": { - "type": "object", - "description": "External tax service configuration.", - "nullable": true, - "properties": { - "url": { - "type": "string", - "nullable": true, - "description": "Endpoint URL." - }, - "authorizationHeader": { - "type": "string", - "description": "Authorization header.", - "nullable": true - }, - "allowExecutionAfterErrors": { - "type": "boolean", - "description": "Allows the purchase to continue even if a tax system problem happens." - }, - "integratedAuthentication": { - "type": "boolean", - "description": "When the tax system is in VTEX auth, use this flag instead of the `authorizationHeader`." - }, - "appId": { - "type": "string", - "description": "Custom data ID sent to the tax system." - } - } - }, - "minimumQuantityAccumulatedForItems": { - "type": "integer", - "format": "int32", - "description": "Minimum SKU quantity by cart." - }, - "decimalDigitsPrecision": { - "type": "integer", - "format": "int32", - "description": "Number of price digits." - }, - "minimumValueAccumulated": { - "type": "integer", - "nullable": true, - "description": "Minimum cart value." - }, - "apps": { - "type": "object", - "nullable": true, - "description": "Apps configuration.", - "properties": { - "id": { - "type": "string", - "description": "App ID." - }, - "fields": { - "type": "array", - "description": "Array of fields available to the app.", - "items": { - "type": "string" - } - }, - "major": { - "type": "integer", - "description": "App major version." - } - } - }, - "allowMultipleDeliveries": { - "type": "boolean", - "nullable": true, - "description": "On the same purchase, allows the selection of items from multiple delivery channels." - }, - "allowManualPrice": { - "type": "boolean", - "nullable": true, - "description": "Allows the editing of SKU prices right in the cart." - }, - "maxNumberOfWhiteLabelSellers": { - "type": "integer", - "description": "Allows the input of a limit of white label sellers involved on the cart." - }, - "maskFirstPurchaseData": { - "type": "boolean", - "description": "Allows, on a first purchase, masking client's data. It could be useful when a shared cart is used and the client doesn't want to share its data." - }, - "recaptchaValidation": { - "type": "string", - "description": "Configures reCAPTCHA validation for the account, defining in which situations the shopper will be prompted to validate a purchase with reCAPTCHA. Learn more about [reCAPTCHA validation for VTEX stores](https://help.vtex.com/tutorial/recaptcha-no-checkout--18Te3oDd7f4qcjKu9jhNzP)\n\r\n\rPossible values are:\n\r- `\"never\"`: no purchases are validated with reCAPTCHA.\n\r- `\"always\"`: every purchase is validated with reCAPTCHA.\n\r- `\"vtexCriteria\"`: only some purchases are validated with reCAPTCHA in order to minimize friction and improve shopping experience. VTEX’s algorithm determines which sessions are trustworthy and which should be validated with reCAPTCHA. This is the recommended option.", - "default": "vtexCriteria" - }, - "paymentSystemToCheckFirstInstallment": { - "type": "string", - "description": "If you want to apply a first installment discount to a particular payment system, set this field to that payment system's ID. Learn more: [Configuring a discount for orders prepaid in full](https://help.vtex.com/en/tutorial/configurar-desconto-de-preco-a-vista--7Lfcj9Wb5dpYfA2gKkACIt).", - "example": "6" - } - }, - "example": { - "paymentConfiguration": { - "requiresAuthenticationForPreAuthorizedPaymentOption": false - }, - "taxConfiguration": null, - "minimumQuantityAccumulatedForItems": 1, - "decimalDigitsPrecision": 2, - "minimumValueAccumulated": null, - "apps": null, - "allowMultipleDeliveries": null, - "allowManualPrice": null - } - }, - "PaymentConfiguration": { - "title": "PaymentConfiguration", - "description": "Payment Configuration object", - "required": [ - "requiresAuthenticationForPreAuthorizedPaymentOption" - ], - "type": "object", - "properties": { - "requiresAuthenticationForPreAuthorizedPaymentOption": { - "type": "boolean", - "description": "Determines whether pre-authorized payments require authentication" - }, - "allowInstallmentsMerge": { - "type": "boolean", - "description": "By default (when `false`), on a multi-seller purchase is on the run, a simple intersection with installments options configured by every seller will be available. When `true`, this option allows a more complex but flexible installment option, since it considers max installments of every seller configuration, even if those don't match. Installment values ​​may not be equal in this case." - } - }, - "example": { - "requiresAuthenticationForPreAuthorizedPaymentOption": false, - "allowInstallmentsMerge": false - } - }, - "WaitingTime": { - "type": "object", - "required": [ - "waitingTime" - ], - "properties": { - "waitingTime": { - "type": "integer", - "description": "Number of days after order cancelation by a seller, during which another seller may be assigned to fulfill the order." - } - } - } - }, - "securitySchemes": { - "appKey": { - "type": "apiKey", - "in": "header", - "name": "X-VTEX-API-AppKey" - }, - "appToken": { - "type": "apiKey", - "in": "header", - "name": "X-VTEX-API-AppToken" - } - } - }, - "tags": [ - { - "name": "Shopping cart" - }, - { - "name": "Cart attachments" - }, - { - "name": "Custom data" - }, - { - "name": "Configuration" - }, - { - "name": "Fulfillment" - }, - { - "name": "Order placement" - }, - { - "name": "Region" - } - ], - "security": [ - { - "appKey": [], - "appToken": [] - } - ] -} \ No newline at end of file diff --git a/public/docs/api-reference/antifraud-provider-protocol-overview.json b/public/docs/api-reference/antifraud-provider-protocol-overview.json deleted file mode 100644 index ac197a00..00000000 --- a/public/docs/api-reference/antifraud-provider-protocol-overview.json +++ /dev/null @@ -1,2878 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "Antifraud Provider", - "description": "Endpoints that deal with to Antifraud Provider operations", - "contact": {}, - "version": "1.0" - }, - "servers": [ - { - "url": "http://{providerApiEndpoint}", - "description": "VTEX server URL", - "variables": { - "providerApiEndpoint": { - "description": "The antifraud provider endpoint URL", - "default": "{providerApiEndpoint}" - } - } - } - ], - "paths": { - "/pre-analysis": { - "post": { - "tags": [ - "Antifraud Flow" - ], - "summary": "Send Antifraud Pre-Analysis Data (optional)", - "description": "Receives a new transaction antifraud data for (synchronous) pre-analysis. This step is performed before payments authorization.", - "operationId": "SendAntifraudPreAnalysisData", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "The Media type of the body of the request. Default value for payment provider protocol is application/json", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "X-PROVIDER-API-AppKey", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppKey}}", - "description": "The AppKey configured by the merchant" - } - }, - { - "name": "X-PROVIDER-API-AppToken", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppToken}}", - "description": "The AppToken configured by the merchant" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SendAntifraudDataRequest" - }, - "example": { - "id": "D3AA1FC8372E430E8236649DB5EBD08E", - "sellerId": "vtexargentina", - "reference": "v32478982vtx-01", - "value": 10, - "ip": "10.0.0.1", - "store": "serasa", - "deviceFingerprint": "Generated_using_GTM_Store_Is_Responsible_To_Configure", - "miniCart": { - "buyer": { - "id": "c1245228-1c68-11e6-94ac-0afa86a846a5", - "firstName": "John", - "lastName": "Doe", - "document": "012.345.678-90", - "documentType": "CPF", - "email": "john@doe.com", - "phone": "+5521987654321", - "address": { - "country": "BRA", - "street": "Rua Praia de Botafogo", - "number": "518", - "complement": "2o. andar", - "neighborhood": "Botafogo", - "postalCode": "22250-040", - "city": "Rio de Janeiro", - "state": "RJ" - } - }, - "shipping": { - "value": 8.41, - "estimatedDate": "2017-08-02T14:46:47", - "address": { - "country": "BRA", - "street": "Rua Praia de Botafogo", - "number": "518", - "complement": "2o. andar", - "neighborhood": "Botafogo", - "postalCode": "22250-040", - "city": "Rio de Janeiro", - "state": "RJ" - } - }, - "items": [ - { - "id": "132981", - "name": "Some useful product", - "price": 20.51, - "quantity": 2, - "deliveryType": "Normal", - "deliverySlaInMinutes": 4320, - "categoryId": "111", - "categoryName": "Electronica", - "discount": 1.99, - "sellerId": "vtexargentina" - }, - { - "id": "123242", - "name": "Some useless product", - "price": 21.98, - "quantity": 1, - "deliveryType": "Normal", - "deliverySlaInMinutes": 4320, - "categoryId": "123", - "categoryName": "Lar", - "discount": 1.01, - "sellerId": "vtexargentina" - } - ], - "taxValue": 5.58, - "listRegistry": { - "name": "Minha lista Presente", - "deliveryToOwner": false - } - }, - "payments": [ - { - "id": "2D00FE", - "method": "CreditCard", - "name": "Visa", - "currencyIso4217": "BRL", - "value": 63.98, - "installments": 3, - "details": { - "bin": "507860", - "lastDigits": "2798", - "holder": "Client", - "address": { - "country": "BRA", - "street": "Rua Praia de Botafogo", - "number": "518", - "complement": "2o. andar", - "neighborhood": "Botafogo", - "postalCode": "22250-040", - "city": "Rio de Janeiro", - "state": "RJ" - } - } - }, - { - "id": "04D430E517B2494FBC3DF7721CCDACC7", - "method": "GiftCard", - "value": 10.01, - "currencyIso4217": "BRL", - "installments": 1 - } - ], - "hook": "https://hook.vtex.com/notifyIfChangeStatus", - "transactionStartDate": "2020-10-30T18:08:23Z" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SendAntifraudData" - }, - "examples": { - "response": { - "value": { - "id": "D3AA1FC8372E430E8236649DB5EBD08E", - "tid": "4692c1f54d514fe69da0b472a3b2a770", - "code": "customCode", - "message": "customMessage", - "status": "approved", - "score": 5.01, - "analysisType": "authomatic", - "responses": { - "foo": "anyFoo", - "custom": "customAnyValue" - } - } - } - } - } - } - } - }, - "deprecated": false - } - }, - "/transactions": { - "post": { - "tags": [ - "Antifraud Flow" - ], - "summary": "Send Antifraud Data", - "description": "Receives a new transaction antifraud data. This step is performed only if all payments are authorized.", - "operationId": "SendAntifraudData", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "The Media type of the body of the request. Default value for payment provider protocol is application/json", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "X-PROVIDER-API-AppKey", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppKey}}" - } - }, - { - "name": "X-PROVIDER-API-AppToken", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppToken}}" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SendAntifraudDataRequest" - }, - "example": { - "id": "D3AA1FC8372E430E8236649DB5EBD08E", - "sellerId": "vtexargentina", - "reference": "v32478982vtx-01", - "value": 10, - "transactionStartDate": "2020-10-30T18:08:23Z", - "ip": "10.0.0.1", - "store": "serasa", - "deviceFingerprint": "Generated_using_GTM_Store_Is_Responsible_To_Configure", - "miniCart": { - "buyer": { - "id": "c1245228-1c68-11e6-94ac-0afa86a846a5", - "firstName": "John", - "lastName": "Doe", - "document": "012.345.678-90", - "documentType": "CPF", - "email": "john@doe.com", - "phone": "+5521987654321", - "address": { - "country": "BRA", - "street": "Rua Praia de Botafogo", - "number": "518", - "complement": "2o. andar", - "neighborhood": "Botafogo", - "postalCode": "22250-040", - "city": "Rio de Janeiro", - "state": "RJ" - } - }, - "shipping": { - "value": 8.41, - "estimatedDate": "2017-08-02T14:46:47", - "address": { - "country": "BRA", - "street": "Rua Praia de Botafogo", - "number": "518", - "complement": "2o. andar", - "neighborhood": "Botafogo", - "postalCode": "22250-040", - "city": "Rio de Janeiro", - "state": "RJ" - } - }, - "items": [ - { - "id": "132981", - "name": "Some useful product", - "price": 20.51, - "quantity": 2, - "deliveryType": "Normal", - "deliverySlaInMinutes": 4320, - "categoryId": "111", - "categoryName": "Electronica", - "discount": 1.99, - "sellerId": "vtexargentina" - }, - { - "id": "123242", - "name": "Some useless product", - "price": 21.98, - "quantity": 1, - "deliveryType": "Normal", - "deliverySlaInMinutes": 4320, - "categoryId": "123", - "categoryName": "Lar", - "discount": 1.01, - "sellerId": "vtexargentina" - } - ], - "taxValue": 5.58, - "listRegistry": { - "name": "Minha lista Presente", - "deliveryToOwner": false - } - }, - "payments": [ - { - "id": "2D00F", - "method": "CreditCard", - "name": "Visa", - "value": 63.98, - "currencyIso4217": "BRL", - "installments": 3, - "details": { - "bin": "507860", - "lastDigits": "2798", - "holder": "John Doe", - "address": { - "country": "BRA", - "street": "Rua Praia de Botafogo", - "number": "518", - "complement": "2o. andar", - "neighborhood": "Botafogo", - "postalCode": "22250-040", - "city": "Rio de Janeiro", - "state": "RJ" - } - } - }, - { - "id": "04D430E517B2494FBC3DF7721CCDACC7", - "method": "GiftCard", - "value": 10.01, - "currencyIso4217": "BRL", - "installments": 1 - } - ], - "hook": "https://hook.vtex.com/notifyIfChangeStatus" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": { - "access-control-allow-credentials": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "true" - } - } - }, - "access-control-allow-origin": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo" - } - } - }, - "cache-control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "connection": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "keep-alive" - } - } - }, - "content-length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "244" - } - } - }, - "content-type": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "application/json; charset=utf-8" - } - } - }, - "date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Mon, 07 May 2018 16:15:43 GMT" - } - } - }, - "expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-1" - } - } - }, - "pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Microsoft-IIS/8.0" - } - } - }, - "x-aspnet-version": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "4.0.30319" - } - } - }, - "x-powered-by": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "ASP.NET" - } - } - }, - "x-vtex-operation-id": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "125de297-43d9-4d71-b89d-d238d0a1e454" - } - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SendAntifraudData" - }, - "example": { - "id": "D3AA1FC8372E430E8236649DB5EBD08E", - "tid": "4692c1f54d514fe69da0b472a3b2a770", - "code": "customCode", - "message": "customMessage", - "status": "received", - "score": 5.01, - "analysisType": "authomatic", - "responses": { - "foo": "anyFoo", - "custom": "customAnyValue" - } - } - } - } - } - }, - "deprecated": false, - "servers": [ - { - "url": "https://{{providerApiEndpoint}}", - "description": "VTEX server URL" - } - ] - } - }, - "/transactions/{transactionId}": { - "put": { - "tags": [ - "Antifraud Flow" - ], - "summary": "Update Antifraud Transactions (optional)", - "description": "Receives a new transaction antifraud data. This step is performed only if all payments are authorized.", - "operationId": "UpdateAntifraudTransactions(optional)", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "application/json" - } - }, - { - "name": "X-PROVIDER-API-AppKey", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppKey}}" - } - }, - { - "name": "X-PROVIDER-API-AppToken", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppToken}}" - } - }, - { - "name": "transactionId", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateAntifraudTransactionsoptionalRequest" - }, - "example": { - "id": "D3AA1FC8372E430E8236649DB5EBD08E", - "reference": "v32478982vtx-01", - "value": 10, - "ip": "10.0.0.1", - "store": "serasa", - "deviceFingerprint": "Generated_using_GTM_Store_Is_Responsible_To_Configure", - "miniCart": { - "buyer": { - "id": "c1245228-1c68-11e6-94ac-0afa86a846a5", - "firstName": "John", - "lastName": "Doe", - "document": "012.345.678-90", - "documentType": "CPF", - "email": "john@doe.com", - "phone": "+5521987654321", - "address": { - "country": "BRA", - "street": "Rua Praia de Botafogo", - "number": "518", - "complement": "2o. andar", - "neighborhood": "Botafogo", - "postalCode": "22250-040", - "city": "Rio de Janeiro", - "state": "RJ" - } - }, - "shipping": { - "value": 8.41, - "estimatedDate": "2017-08-02T14:46:47", - "address": { - "country": "BRA", - "street": "Rua Praia de Botafogo", - "number": "518", - "complement": "2o. andar", - "neighborhood": "Botafogo", - "postalCode": "22250-040", - "city": "Rio de Janeiro", - "state": "RJ" - } - }, - "items": [ - { - "id": "132981", - "name": "Some useful product", - "price": 20.51, - "quantity": 2, - "deliveryType": "Normal", - "deliverySlaInMinutes": 4320, - "categoryId": "111", - "categoryName": "Electronica", - "discount": 1.99, - "sellerId": "vtexargentina" - }, - { - "id": "123242", - "name": "Some useless product", - "price": 21.98, - "quantity": 1, - "deliveryType": "Normal", - "deliverySlaInMinutes": 4320, - "categoryId": "123", - "categoryName": "Lar", - "discount": 1.01, - "sellerId": "vtexargentina" - } - ], - "taxValue": 5.58, - "listRegistry": { - "name": "Minha lista Presente", - "deliveryToOwner": false - } - }, - "payments": [ - { - "id": "2D00FE", - "method": "CreditCard", - "name": "Visa", - "value": 63.98, - "currencyIso4217": "BRL", - "installments": 3, - "details": { - "bin": "507860", - "lastDigits": "2798", - "holder": "John Doe", - "address": { - "country": "BRA", - "street": "Rua Praia de Botafogo", - "number": "518", - "complement": "2o. andar", - "neighborhood": "Botafogo", - "postalCode": "22250-040", - "city": "Rio de Janeiro", - "state": "RJ" - } - } - }, - { - "id": "04D430E517B2494FBC3DF7721CCDACC7", - "method": "GiftCard", - "value": 10.01, - "currencyIso4217": "BRL", - "installments": 1 - } - ], - "hook": "https://hook.vtex.com/notifyIfChangeStatus" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": { - "Access-Control-Allow-Credentials": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "true" - } - } - }, - "Access-Control-Allow-Origin": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "chrome-extension://aicmkgpgakddgnaphhhpliifpcfhicfo" - } - } - }, - "Cache-Control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Connection": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "keep-alive" - } - } - }, - "Content-Length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "132" - } - } - }, - "Date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Wed, 02 Aug 2017 18:21:50 GMT" - } - } - }, - "Expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-1" - } - } - }, - "Pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Microsoft-IIS/8.0" - } - } - }, - "X-AspNet-Version": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "4.0.30319" - } - } - }, - "X-Powered-By": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "ASP.NET" - } - } - }, - "x-vtex-operation-id": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "4d2e58c7-ea79-4420-96db-8e4bf32847ce" - } - } - } - }, - "content": { - "application/json; charset=utf-8": { - "schema": { - "$ref": "#/components/schemas/ApproveAntifraudAnalysisResponse" - }, - "example": { - "id": "D3AA1FC8372E430E8236649DB5EBD08E", - "status": "approved", - "fraudRiskPercentage": 0.0, - "analysisType": "authomatic", - "responses": null - } - } - } - } - }, - "deprecated": false, - "servers": [ - { - "url": "http://{{providerApiEndpoint}}", - "description": "VTEX server URL" - } - ] - } - }, - "/manifest": { - "get": { - "tags": [ - "Antifraud Flow" - ], - "summary": "List Antifraud Provider Manifest", - "description": "Returns the custom fields of the antifraud provider manifest", - "operationId": "Manifest", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "The Media type of the body of the request. Default value for antifraud provider protocol is application/json", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Accept", - "in": "header", - "description": "Media type(s) that is/are acceptable for the response. Default value for antifraud provider protocol is application/json", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Success" - }, - "examples": { - "response": { - "value": { - "cardholderDocument": "required", - "customFields": [ - { - "name": "ApiKey", - "type": "text" - }, - { - "name": "AnalysisLocation", - "type": "select", - "options": [ - { - "text": "MEX", - "value": "Latin America" - }, - { - "text": "USA", - "value": "United States" - } - ] - } - ] - } - } - } - } - } - } - }, - "deprecated": false - } - }, - "/transactions/{transactions.id}": { - "get": { - "tags": [ - "Antifraud Flow" - ], - "summary": "Get Antifraud Status", - "description": "GET antifraud Status. Implement this API because VTEX will call it to get the status of the antifraud analysis.", - "operationId": "GetAntifraudStatus", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "application/json" - } - }, - { - "name": "X-PROVIDER-API-AppKey", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppKey}}" - } - }, - { - "name": "X-PROVIDER-API-AppToken", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppToken}}" - } - }, - { - "name": "transactions.id", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": { - "cache-control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "connection": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "keep-alive" - } - } - }, - "content-length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "212" - } - } - }, - "content-type": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "application/json; charset=utf-8" - } - } - }, - "date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Thu, 03 May 2018 18:48:27 GMT" - } - } - }, - "expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-1" - } - } - }, - "pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Microsoft-IIS/8.0" - } - } - }, - "x-aspnet-version": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "4.0.30319" - } - } - }, - "x-powered-by": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "ASP.NET" - } - } - }, - "x-vtex-operation-id": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "c7e11326-136e-43f8-8a91-4ac56ac55a41" - } - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetAntifraudStatus" - }, - "example": { - "id": "BF900B7CB15147F98D91208989100A05", - "tid": "3146f46162f042f483cd3979ba4e8317", - "status": "approved", - "fraudRiskPercentage": 5.01, - "analysisType": "authomatic", - "responses": { - "foo": "anyFoo", - "custom": "customAnyValue" - } - } - } - } - } - }, - "deprecated": false, - "servers": [ - { - "url": "http://{{providersApiEndpoint}}.com", - "description": "VTEX server URL" - } - ] - } - }, - "/transactions/{transactions.Id}": { - "delete": { - "tags": [ - "Antifraud Flow" - ], - "summary": "Stop Antifraud Analysis (optional)", - "description": "Stop antifraud analysis.", - "operationId": "StopAntifraudAnalysis(optional)", - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "example": "application/json" - } - }, - { - "name": "X-PROVIDER-API-AppKey", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppKey}}" - } - }, - { - "name": "X-PROVIDER-API-AppToken", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppToken}}" - } - }, - { - "name": "transactions.Id", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": { - "Cache-Control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Connection": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "keep-alive" - } - } - }, - "Content-Length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "133" - } - } - }, - "Date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Wed, 02 Aug 2017 18:20:51 GMT" - } - } - }, - "Expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-1" - } - } - }, - "Pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Microsoft-IIS/8.0" - } - } - }, - "X-AspNet-Version": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "4.0.30319" - } - } - }, - "X-Powered-By": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "ASP.NET" - } - } - }, - "x-vtex-operation-id": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "30984ee5-21fa-4618-b599-ec1dbf56e556" - } - } - } - }, - "content": { - "application/json; charset=utf-8": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GetPaymentMethodsSupported" - } - }, - "example": [ - { - "name": "CreditCard" - }, - { - "name": "DebitCard" - }, - { - "name": "GiftCard" - }, - { - "name": "BankIssueInvoice" - }, - { - "name": "Voucher" - }, - { - "name": "Promissory" - } - ] - } - } - } - }, - "deprecated": false, - "servers": [ - { - "url": "http://{{providersApiEndpoint}}.com", - "description": "VTEX server URL" - } - ] - } - }, - "/authorization/token": { - "post": { - "tags": [ - "OAuth Flow" - ], - "summary": "1. Retrieve Token", - "description": "In this API Call VTEX will expect a token to be created.", - "operationId": "1.RetrieveToken", - "parameters": [], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/1.RetrieveTokenRequest" - }, - "example": { - "applicationId": "vtex", - "returnUrl": "https://storevtex.vtexpayments.com/?authorizationCode=" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": { - "Cache-Control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Connection": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "keep-alive" - } - } - }, - "Content-Length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "71" - } - } - }, - "Date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Mon, 16 Jul 2018 15:10:44 GMT" - } - } - }, - "Expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-1" - } - } - }, - "Pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Microsoft-IIS/8.0" - } - } - }, - "X-AspNet-Version": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "4.0.30319" - } - } - }, - "X-Powered-By": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "ASP.NET" - } - } - }, - "x-vtex-operation-id": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "d8f17ed2-ba9f-4f6d-8f8c-52bd425d7a52" - } - } - } - }, - "content": { - "application/json; charset=utf-8": { - "schema": { - "$ref": "#/components/schemas/1.RetrieveToken" - }, - "example": { - "applicationId": "vtex", - "token": "358a5bea-07d0-4122-888a-54ab70b5f02f" - } - } - } - } - }, - "deprecated": false, - "servers": [ - { - "url": "http://{providerApiEndpoint}/authorization", - "variables": { - "providerBaseUrl": { - "default": "DefaultParameterValue" - } - } - } - ] - } - }, - "/redirect": { - "get": { - "tags": [ - "OAuth Flow" - ], - "summary": "2. Redirect", - "description": "VTEX will redirect the store administrator to the Payment Provider Web Site.", - "operationId": "2.Redirect", - "parameters": [ - { - "name": "token", - "in": "query", - "description": "", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "{token}" - } - }, - { - "name": "applicationId", - "in": "query", - "description": "", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "vtex" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {} - } - }, - "deprecated": false, - "servers": [ - { - "url": "http://{{providerApiEndpoint}}", - "variables": { - "providerBaseUrl": { - "default": "DefaultParameterValue" - } - } - } - ] - } - }, - "/authorizationCode={providerAuthorizationCode}": { - "get": { - "tags": [ - "OAuth Flow" - ], - "summary": "3. Return to VTEX", - "description": "The PROVIDER will redirect the store administrator to the VTEX Web Site.", - "operationId": "3.ReturntoVTEX", - "parameters": [ - { - "name": "providerAuthorizationCode", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "explode": true, - "schema": { - "type": "string", - "example": "{providerAuthorizationCode}" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {} - } - }, - "deprecated": false, - "servers": [ - { - "url": "http://{{providerApiEndpoint}}", - "variables": { - "returnUrl": { - "default": "DefaultParameterValue" - } - } - } - ] - } - }, - "/authorization/credentials": { - "get": { - "tags": [ - "OAuth Flow" - ], - "summary": "4. Get Credentials", - "description": "", - "operationId": "4.GetCredentials", - "parameters": [ - { - "name": "authorizationCode", - "in": "query", - "description": "", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "{authorizationCode}" - } - }, - { - "name": "applicationId", - "in": "query", - "description": "", - "required": true, - "style": "form", - "explode": true, - "schema": { - "type": "string", - "example": "vtex" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": { - "Cache-Control": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Connection": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "keep-alive" - } - } - }, - "Content-Length": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "122" - } - } - }, - "Date": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Mon, 16 Jul 2018 14:22:51 GMT" - } - } - }, - "Expires": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "-1" - } - } - }, - "Pragma": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "no-cache" - } - } - }, - "Server": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "Microsoft-IIS/8.0" - } - } - }, - "X-AspNet-Version": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "4.0.30319" - } - } - }, - "X-Powered-By": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "ASP.NET" - } - } - }, - "x-vtex-operation-id": { - "content": { - "text/plain": { - "schema": { - "type": "string" - }, - "example": "187e390e-8cf8-4f42-a376-242f5ef4f740" - } - } - } - }, - "content": { - "application/json; charset=utf-8": { - "schema": { - "$ref": "#/components/schemas/3.GetCredentials" - }, - "example": { - "applicationId": "vtex", - "appKey": "c5a5e3f1-4a77-4a00-8b53-0d1adb3e9628", - "appToken": "57ea254d-f3d3-488d-88d7-129766037ed1" - } - } - } - } - }, - "deprecated": false, - "servers": [ - { - "url": "http://{providerBaseUrl}/authorization", - "variables": { - "providerBaseUrl": { - "default": "DefaultParameterValue" - } - } - } - ] - } - } - }, - "components": { - "securitySchemes": { - "appKey": { - "type": "apiKey", - "in": "header", - "name": "X-VTEX-API-AppKey" - }, - "appToken": { - "type": "apiKey", - "in": "header", - "name": "X-VTEX-API-AppToken" - } - }, - "schemas": { - "Success": { - "title": "Success", - "required": [ - "customFields" - ], - "type": "object", - "properties": { - "cardholderDocument":{ - "type": "string", - "description": "Indicates the requirement of cardholder document in card transactions. The field has three possible values: `required`, `optional`, or `unused`." - }, - "customFields": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - }, - "description": "" - } - }, - "example": { - "customFields": [ - { - "name": "ApiKey", - "type": "text" - }, - { - "name": "AnalysisLocation", - "type": "select", - "options": [ - { - "text": "MEX", - "value": "Latin America" - }, - { - "text": "USA", - "value": "United States" - } - ] - } - ] - } - }, - "SendAntifraudDataRequest": { - "title": "SendAntifraudDataRequest", - "required": [ - "id", - "reference", - "value", - "ip", - "store", - "deviceFingerprint", - "miniCart", - "payments", - "sellerId", - "hook", - "transactionStartDate" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "default": "D3AA1F", - "description": "VTEX transaction ID. The ID of the transaction related with this payment." - }, - "reference": { - "type": "string", - "default": "v32vtx-01", - "description": "VTEX order reference key. The key of the order (from VTEX OMS system) related with this payment." - }, - "value": { - "type": "integer", - "format": "int32", - "default": 10, - "description": "VTEX transaction order value." - }, - "ip": { - "type": "string", - "default": "10.0.0.1", - "description": "The original ip address from browser." - }, - "store": { - "type": "string", - "default": "insert store name here", - "description": "VTEX has a main Name for the store. This unique name is often used in url to access VTEX configurations." - }, - "deviceFingerprint": { - "type": "string", - "default": "insert device here", - "description": "Device fingerprint generated by the provider. This is generated by using Google Tag Manager that the provider implements. This field is optional, is sent only if received. See **Implement Device Fingerprint**" - }, - "miniCart": { - "$ref": "#/components/schemas/MiniCart" - }, - "payments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Payment" - }, - "description": "" - }, - "hook": { - "type": "string", - "description": "URL to be called when the payment has it's status changed" - }, - "transactionStartDate": { - "type": "string", - "default": "2020-10-30T18:08:23Z", - "description": "The date and time when the transaction started. It must be in the ISO 8601 format" - } - }, - "default": { - "id": "D3AA1FC8372E430E8236649DB5EBD08E", - "sellerId": "vtexargentina", - "reference": "v32478982vtx-01", - "value": 10, - "ip": "10.0.0.1", - "store": "serasa", - "deviceFingerprint": "Generated_using_GTM_Store_Is_Responsible_To_Configure", - "miniCart": { - "buyer": { - "id": "c1245228-1c68-11e6-94ac-0afa86a846a5", - "firstName": "John", - "lastName": "Doe", - "document": "012.345.678-90", - "documentType": "CPF", - "email": "john@doe.com", - "phone": "+5521987654321", - "address": { - "country": "BRA", - "street": "Rua Praia de Botafogo", - "number": "518", - "complement": "2o. andar", - "neighborhood": "Botafogo", - "postalCode": "22250-040", - "city": "Rio de Janeiro", - "state": "RJ" - } - }, - "shipping": { - "value": 8.41, - "estimatedDate": "2017-08-02T14:46:47", - "address": { - "country": "BRA", - "street": "Rua Praia de Botafogo", - "number": "518", - "complement": "2o. andar", - "neighborhood": "Botafogo", - "postalCode": "22250-040", - "city": "Rio de Janeiro", - "state": "RJ" - } - }, - "items": [ - { - "id": "132981", - "name": "Some useful product", - "price": 20.51, - "quantity": 2, - "deliveryType": "Normal", - "deliverySlaInMinutes": 4320, - "categoryId": "111", - "categoryName": "Electronica", - "discount": 1.99, - "sellerId": "vtexargentina" - }, - { - "id": "123242", - "name": "Some useless product", - "price": 21.98, - "quantity": 1, - "deliveryType": "Normal", - "deliverySlaInMinutes": 4320, - "categoryId": "123", - "categoryName": "Lar", - "discount": 1.01, - "sellerId": "vtexargentina" - } - ], - "taxValue": 5.58, - "listRegistry": { - "name": "Minha lista Presente", - "deliveryToOwner": false - } - }, - "payments": [ - { - "id": "2D00", - "method": "Credit Card", - "name": "Visa", - "value": 63.98, - "currencyIso4217": "BRL", - "installments": 3, - "details": { - "bin": "507860", - "lastDigits": "2798", - "holder": "example", - "address": { - "country": "BRA", - "street": "address", - "number": "518", - "complement": "address", - "neighborhood": "address", - "postalCode": "insert postal code here", - "city": "Rio de Janeiro", - "state": "RJ" - } - } - }, - { - "id": "04D4", - "method": "Gift Card", - "name": "example", - "value": 10.01, - "currencyIso4217": "BRL", - "installments": 1 - } - ], - "hook": "https://hook.vtex.com/notifyIfChangeStatus", - "transactionStartDate": "2020-10-30T18:08:23Z" - } - }, - "MiniCart": { - "title": "MiniCart", - "required": [ - "buyer", - "shipping", - "items", - "taxValue", - "listRegistry" - ], - "type": "object", - "properties": { - "buyer": { - "$ref": "#/components/schemas/Buyer" - }, - "shipping": { - "$ref": "#/components/schemas/Shipping" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Item" - }, - "description": "" - }, - "taxValue": { - "type": "number", - "description": "Total tax value" - }, - "listRegistry": { - "$ref": "#/components/schemas/ListRegistry" - } - }, - "default": { - "buyer": { - "id": "c12", - "firstName": "example", - "lastName": "example", - "document": "999.999.999-99", - "documentType": "CPF", - "email": "email@domain.com", - "phone": "+552199999999", - "address": { - "country": "BRA", - "street": "address", - "number": "518", - "complement": "address", - "neighborhood": "example", - "postalCode": "insert postal code here", - "city": "Rio de Janeiro", - "state": "RJ" - } - }, - "shipping": { - "value": 8.41, - "estimatedDate": "2017-08-02T14:46:47", - "address": { - "country": "BRA", - "street": "address", - "number": "518", - "complement": "address", - "neighborhood": "address", - "postalCode": "insert postal code here", - "city": "Rio de Janeiro", - "state": "RJ" - } - }, - "items": [ - { - "id": "13", - "name": "example", - "price": 20.51, - "quantity": 2, - "deliveryType": "express", - "deliverySlaInMinutes": 4320, - "categoryId": "111", - "categoryName": "example", - "discount": 1.99, - "sellerId": "vtexargentina" - }, - { - "id": "123242", - "name": "example", - "price": 21.98, - "quantity": 1, - "deliveryType": "express", - "deliverySlaInMinutes": 4320, - "categoryId": "123", - "categoryName": "example", - "discount": 1.01, - "sellerId": "vtexargentina" - } - ], - "taxValue": 5.58, - "listRegistry": { - "name": "example", - "deliveryToOwner": false - } - } - }, - "Buyer": { - "title": "Buyer", - "required": [ - "id", - "firstName", - "lastName", - "document", - "documentType", - "email", - "phone", - "address" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "VTEX buyer ID. The unique identifier of the buyer" - }, - "firstName": { - "type": "string", - "description": "First name of the buyer" - }, - "lastName": { - "type": "string", - "description": "Last name of the buyer" - }, - "document": { - "type": "string", - "description": "Document number of the buyer" - }, - "documentType": { - "type": "string", - "description": "Type of document of the buyer. It depends on the country" - }, - "email": { - "type": "string", - "description": "Email of the buyer" - }, - "phone": { - "type": "string", - "description": "Phone number of the buyer" - }, - "address": { - "$ref": "#/components/schemas/Address" - } - }, - "default": { - "id": "c1245228", - "firstName": "example", - "lastName": "example", - "document": "099.999.999-99", - "documentType": "CPF", - "email": "email@domain.com", - "phone": "+55219999999999", - "address": { - "country": "BRA", - "street": "address", - "number": "518", - "complement": "address", - "neighborhood": "address", - "postalCode": "insert postal code here", - "city": "Rio de Janeiro", - "state": "RJ" - } - } - }, - "Address": { - "title": "Address", - "required": [ - "country", - "street", - "number", - "complement", - "neighborhood", - "postalCode", - "city", - "state" - ], - "type": "object", - "properties": { - "country": { - "type": "string", - "description": "Buyer address country" - }, - "street": { - "type": "string", - "description": "Buyer address street" - }, - "number": { - "type": "string", - "description": "Buyer address number" - }, - "complement": { - "type": "string", - "description": "Buyer address complement" - }, - "neighborhood": { - "type": "string", - "description": "Buyer address neighborhood" - }, - "postalCode": { - "type": "string", - "description": "Buyer address postal code" - }, - "city": { - "type": "string", - "description": "Buyer address city" - }, - "state": { - "type": "string", - "description": "Buyer address state" - } - }, - "example": { - "country": "BRA", - "street": "Rua Praia de Botafogo", - "number": "518", - "complement": "2o. andar", - "neighborhood": "Botafogo", - "postalCode": "22250-040", - "city": "Rio de Janeiro", - "state": "RJ" - } - }, - "Shipping": { - "title": "Shipping", - "required": [ - "value", - "estimatedDate", - "address" - ], - "type": "object", - "properties": { - "value": { - "type": "number", - "description": "Shipping value with two decimal places" - }, - "estimatedDate": { - "type": "string", - "description": "Estimated shipping date ISO 8601" - }, - "address": { - "$ref": "#/components/schemas/Address" - } - }, - "example": { - "value": 8.41, - "estimatedDate": "2017-08-02T14:46:47", - "address": { - "country": "BRA", - "street": "Rua Praia de Botafogo", - "number": "518", - "complement": "2o. andar", - "neighborhood": "Botafogo", - "postalCode": "22250-040", - "city": "Rio de Janeiro", - "state": "RJ" - } - } - }, - "Item": { - "title": "Item", - "required": [ - "id", - "name", - "price", - "quantity", - "deliveryType", - "deliverySlaInMinutes", - "categoryId", - "categoryName", - "discount", - "sellerId" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "VTEX product ID. The ID of the item" - }, - "name": { - "type": "string", - "description": "Item name" - }, - "price": { - "type": "number", - "description": "Item price" - }, - "quantity": { - "type": "integer", - "format": "int32", - "description": "Quantity of this item in the cart" - }, - "deliveryType": { - "type": "string", - "description": "Type of delivery configured by the store" - }, - "deliverySlaInMinutes": { - "type": "integer", - "format": "int32", - "description": "Each item can have a separate shipping sla in minutes" - }, - "categoryId": { - "type": "string", - "description": "Category ID for the Item. Configured by each store" - }, - "categoryName": { - "type": "string", - "description": "Category name for the Item. Configured by each store" - }, - "discount": { - "type": "number", - "description": "Discount applied on item(s) two decimal places" - }, - "sellerId": { - "type": "string", - "description": "In case of a marketplace transaction, this is the Id of the seller for this specific item. Otherwise, this is filled with a '1'" - } - }, - "example": { - "id": "132981", - "name": "Some useful product", - "price": 20.51, - "quantity": 2, - "deliveryType": "Normal", - "deliverySlaInMinutes": 4320, - "categoryId": "111", - "categoryName": "Electronica", - "discount": 1.99, - "sellerId": "vtexargentina" - } - }, - "ListRegistry": { - "title": "ListRegistry", - "required": [ - "name", - "deliveryToOwner" - ], - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "List name defined by the store" - }, - "deliveryToOwner": { - "type": "boolean", - "description": "Flag to mark if the order will be delivered to list creator or not" - } - }, - "example": { - "name": "Minha lista Presente", - "deliveryToOwner": false - } - }, - "Payment": { - "title": "Payment", - "required": [ - "id", - "method", - "value", - "currencyIso4217", - "installments" - ], - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Payment ID unique identifier in VTEX" - }, - "method": { - "type": "string", - "description": "Payment method used for the buyer" - }, - "name": { - "type": "string", - "description": "Payment name used for the buyer. This name could be the brand card or the VTEX payment method" - }, - "value": { - "type": "number", - "description": "Payment value. Two decimal places" - }, - "currencyIso4217": { - "type": "string", - "description": "The currency used in each payment in the Transaction. It must be in the ISO 4217 format." - }, - "installments": { - "type": "integer", - "format": "int32", - "description": "Number of installments" - }, - "details": { - "$ref": "#/components/schemas/Details" - } - }, - "default": { - "id": "2D00FEBB", - "method": "CreditCard", - "name": "Visa", - "value": 63.98, - "currencyIso4217": "BRL", - "installments": 3, - "details": { - "bin": "507860", - "lastDigits": "2798", - "holder": "John Doe", - "address": { - "country": "BRA", - "street": "Rua Praia de Botafogo", - "number": "518", - "complement": "2o. andar", - "neighborhood": "Botafogo", - "postalCode": "22250-040", - "city": "Rio de Janeiro", - "state": "RJ" - } - } - } - }, - "Details": { - "title": "Details", - "required": [ - "bin", - "lastDigits", - "holder", - "address" - ], - "type": "object", - "properties": { - "bin": { - "type": "string", - "description": "Abbreviation for 'Bank Identification Number'. It's a code that identifies the institution responsable for issuing the credit card. " - }, - "lastDigits": { - "type": "string", - "description": "Credit card identifier number last digits" - }, - "holder": { - "type": "string", - "description": "Credit card owner" - }, - "address": { - "$ref": "#/components/schemas/Address" - } - }, - "default": { - "bin": "507860", - "lastDigits": "2798", - "holder": "example", - "address": { - "country": "BRA", - "street": "address", - "number": "518", - "complement": "address", - "neighborhood": "address", - "postalCode": "insert postal code here", - "city": "Rio de Janeiro", - "state": "RJ" - } - } - }, - "SendAntifraudData": { - "title": "SendAntifraudData", - "required": [ - "id", - "tid", - "code", - "message", - "status", - "score", - "analysisType", - "responses" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "tid": { - "type": "string" - }, - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "status": { - "type": "string" - }, - "score": { - "type": "number" - }, - "analysisType": { - "type": "string" - }, - "responses": { - "$ref": "#/components/schemas/Responses" - } - }, - "default": { - "id": "D3AA1F", - "tid": "4692c1", - "code": "customCode", - "message": "customMessage", - "status": "approved", - "score": 5.01, - "analysisType": "authomatic", - "responses": { - "foo": "anyFoo", - "custom": "customAnyValue" - } - } - }, - "Responses": { - "title": "Responses", - "required": [ - "foo", - "custom" - ], - "type": "object", - "properties": { - "foo": { - "type": "string" - }, - "custom": { - "type": "string" - } - }, - "default": { - "foo": "anyFoo", - "custom": "customAnyValue" - } - }, - "UpdateAntifraudTransactionsoptionalRequest": { - "title": "UpdateAntifraudTransactions(optional)Request", - "required": [ - "id", - "reference", - "value", - "ip", - "store", - "deviceFingerprint", - "miniCart", - "payments", - "hook" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "reference": { - "type": "string" - }, - "value": { - "type": "integer", - "format": "int32" - }, - "ip": { - "type": "string" - }, - "store": { - "type": "string" - }, - "deviceFingerprint": { - "type": "string" - }, - "miniCart": { - "$ref": "#/components/schemas/MiniCart" - }, - "payments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Payment" - }, - "description": "" - }, - "hook": { - "type": "string" - } - }, - "example": { - "id": "D3AA1FC8372E430E8236649DB5EBD08E", - "reference": "v32478982vtx-01", - "value": 10, - "ip": "10.0.0.1", - "store": "serasa", - "deviceFingerprint": "Generated_using_GTM_Store_Is_Responsible_To_Configure", - "miniCart": { - "buyer": { - "id": "c1245228-1c68-11e6-94ac-0afa86a846a5", - "firstName": "John", - "lastName": "Doe", - "document": "012.345.678-90", - "documentType": "CPF", - "email": "john@doe.com", - "phone": "+5521987654321", - "address": { - "country": "BRA", - "street": "Rua Praia de Botafogo", - "number": "518", - "complement": "2o. andar", - "neighborhood": "Botafogo", - "postalCode": "22250-040", - "city": "Rio de Janeiro", - "state": "RJ" - } - }, - "shipping": { - "value": 8.41, - "estimatedDate": "2017-08-02T14:46:47", - "address": { - "country": "BRA", - "street": "Rua Praia de Botafogo", - "number": "518", - "complement": "2o. andar", - "neighborhood": "Botafogo", - "postalCode": "22250-040", - "city": "Rio de Janeiro", - "state": "RJ" - } - }, - "items": [ - { - "id": "132981", - "name": "Some useful product", - "price": 20.51, - "quantity": 2, - "deliveryType": "Normal", - "deliverySlaInMinutes": 4320, - "categoryId": "111", - "categoryName": "Electronica", - "discount": 1.99, - "sellerId": "vtexargentina" - }, - { - "id": "123242", - "name": "Some useless product", - "price": 21.98, - "quantity": 1, - "deliveryType": "Normal", - "deliverySlaInMinutes": 4320, - "categoryId": "123", - "categoryName": "Lar", - "discount": 1.01, - "sellerId": "vtexargentina" - } - ], - "taxValue": 5.58, - "listRegistry": { - "name": "Minha lista Presente", - "deliveryToOwner": false - } - }, - "payments": [ - { - "id": "2D00", - "method": "CreditCard", - "name": "Visa", - "value": 63.98, - "currencyIso4217": "BRL", - "installments": 3, - "details": { - "bin": "507", - "lastDigits": "2798", - "holder": "example", - "address": { - "country": "BRA", - "street": "Rua Praia de Botafogo", - "number": "518", - "complement": "2o. andar", - "neighborhood": "Botafogo", - "postalCode": "22250-040", - "city": "Rio de Janeiro", - "state": "RJ" - } - } - }, - { - "id": "04D4", - "method": "Gift Card", - "value": 10.01, - "currencyIso4217": "BRL", - "installments": 1 - } - ], - "hook": "https://hook.vtex.com/notifyIfChangeStatus" - } - }, - "ApproveAntifraudAnalysisResponse": { - "title": "ApproveAntifraudAnalysisResponse", - "required": [ - "id", - "status", - "fraudRiskPercentage", - "analysisType", - "responses" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "status": { - "type": "string" - }, - "fraudRiskPercentage": { - "type": "number" - }, - "analysisType": { - "type": "string" - }, - "responses": { - "type": "string", - "nullable": true - } - }, - "example": { - "id": "D3AA1FC8372E430E8236649DB5EBD08E", - "status": "approved", - "fraudRiskPercentage": 0.0, - "analysisType": "authomatic", - "responses": null - } - }, - "GetAntifraudStatus": { - "title": "GetAntifraudStatus", - "required": [ - "id", - "tid", - "status", - "fraudRiskPercentage", - "analysisType", - "responses" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "tid": { - "type": "string" - }, - "status": { - "type": "string" - }, - "fraudRiskPercentage": { - "type": "number" - }, - "analysisType": { - "type": "string" - }, - "responses": { - "$ref": "#/components/schemas/Responses" - } - }, - "example": { - "id": "BF900B7CB15147F98D91208989100A05", - "tid": "3146f46162f042f483cd3979ba4e8317", - "status": "approved", - "fraudRiskPercentage": 5.01, - "analysisType": "authomatic", - "responses": { - "foo": "anyFoo", - "custom": "customAnyValue" - } - } - }, - "GetPaymentMethodsSupported": { - "title": "GetPaymentMethodsSupported", - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "type": "string" - } - }, - "example": { - "name": "CreditCard" - } - }, - "1.RetrieveTokenRequest": { - "title": "1.RetrieveTokenRequest", - "required": [ - "applicationId", - "returnUrl" - ], - "type": "object", - "properties": { - "applicationId": { - "type": "string" - }, - "returnUrl": { - "type": "string" - } - }, - "example": { - "applicationId": "vtex", - "returnUrl": "https://storevtex.vtexpayments.com/?authorizationCode=" - } - }, - "1.RetrieveToken": { - "title": "1.RetrieveToken", - "required": [ - "applicationId", - "token" - ], - "type": "object", - "properties": { - "applicationId": { - "type": "string" - }, - "token": { - "type": "string" - } - }, - "example": { - "applicationId": "vtex", - "token": "358a5bea-07d0-4122-888a-54ab70b5f02f" - } - }, - "3.GetCredentials": { - "title": "3.GetCredentials", - "required": [ - "applicationId", - "appKey", - "appToken" - ], - "type": "object", - "properties": { - "applicationId": { - "type": "string" - }, - "appKey": { - "type": "string" - }, - "appToken": { - "type": "string" - } - }, - "example": { - "applicationId": "vtex", - "appKey": "c5a5e3f1-4a77-4a00-8b53-0d1adb3e9628", - "appToken": "57ea254d-f3d3-488d-88d7-129766037ed1" - } - } - } - }, - "tags": [ - { - "name": "Antifraud Flow" - }, - { - "name": "OAuth Flow" - } - ], - "security": [ - { - "appKey": [], - "appToken": [] - } - ] -} \ No newline at end of file diff --git a/public/docs/api-reference/giftcard.json b/public/docs/api-reference/giftcard.json deleted file mode 100644 index 071250af..00000000 --- a/public/docs/api-reference/giftcard.json +++ /dev/null @@ -1,2389 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "GiftCard Hub API", - "description": "The GiftCard Hub API allows interaction with all GiftCard Providers registered to a store from a single point. GiftCradsProviders are systems capable of providing cards for use in the buying process.\n\nThe following is the sequence diagram that represents calls in the purchase closing process.\n\n![alt Picking and Packing Actors](https://raml.vtexlab.com.br/gift-card-hub/images/CardByList.png \"Flow\")\n\n**Checkout + Gateway**: Systems responsible for the sale and processing orders and payments.\n\n**GiftCard Hub**: System responsible for managing multiple registered giftacard providers for a store.\n\n**GiftCard Provider**: System responsible for providing the giftcards available to the user not closing purchase. This system can be implemented by third parties.", - "contact": {}, - "version": "1.0" - }, - "servers": [ - { - "url": "https://{accountName}.{environment}.com.br/api", - "description": "VTEX server url", - "variables": { - "accountName": { - "description": "Name of the VTEX account. Used as part of the URL", - "default": "{accountName}" - }, - "environment": { - "description": "Environment to use. Used as part of the URL.", - "default": "{environment}" - } - } - } - ], - "paths": { - "/giftcardproviders": { - "get": { - "tags": ["Provider"], - "summary": "List All GiftCard Providers", - "description": "Returns a collection of giftcard providers from a store.", - "operationId": "ListAllGiftCardProviders", - "parameters": [ - { - "name": "Accept", - "in": "header", - "description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "The Media type of the body of the request. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "REST-Range", - "in": "header", - "description": "Pagination control. This query variable must follow the format _resources={from}-{to}_.", - "required": false, - "style": "simple", - "schema": { - "type": "string", - "default": "resources=0-49" - } - }, - { - "name": "X-VTEX-API-AppKey", - "in": "header", - "description": "VTEX API AppKey", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppKey}}" - } - }, - { - "name": "X-VTEX-API-AppToken", - "in": "header", - "description": "VTEX API AppToken", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppToken}}" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "text/plain": { - "schema": { - "type": "object" - } - } - } - } - }, - "deprecated": false, - "security": [] - } - }, - "/giftcardproviders/{giftCardProviderId}": { - "get": { - "tags": ["Provider"], - "summary": "Get GiftCard Provider by ID", - "description": "Returns a giftcard provider from a store.", - "operationId": "GetGiftCardProviderbyID", - "parameters": [ - { - "name": "Accept", - "in": "header", - "description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "The Media type of the body of the request. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "X-VTEX-API-AppKey", - "in": "header", - "description": "VTEX API AppKey", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppKey}}" - } - }, - { - "name": "X-VTEX-API-AppToken", - "in": "header", - "description": "VTEX API AppToken", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppToken}}" - } - }, - { - "name": "giftCardProviderId", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "insert identifier here" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "text/plain": { - "schema": { - "type": "object" - } - } - } - }, - "404": { - "description": "O provider não existe.\n" - } - }, - "deprecated": false - } - }, - "/giftcardproviders/{giftCardProviderID}": { - "put": { - "tags": ["Provider"], - "summary": "Create/Update GiftCard Provider by ID", - "description": "Create or update a giftcard provider from a store.", - "operationId": "Create/UpdateGiftCardProviderbyID", - "parameters": [ - { - "name": "Accept", - "in": "header", - "description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "The Media type of the body of the request. Default value for payment provider protocol is application/json", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "X-VTEX-API-AppKey", - "in": "header", - "description": "VTEX API AppKey", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppKey}}" - } - }, - { - "name": "X-VTEX-API-AppToken", - "in": "header", - "description": "VTEX API AppToken", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppToken}}" - } - }, - { - "name": "giftCardProviderID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "insert identifier here" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/vnd.vtex.giftcardproviders.v1+json": { - "schema": { - "$ref": "#/components/schemas/CreateUpdateGiftCardProviderbyIDRequest" - }, - "example": { - "serviceUrl": "https://api.vtex.com.br/basedevmkp", - "oauthProvider": "vtex", - "preAuthEnabled": true, - "cancelEnabled": true - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "text/plain": { - "schema": { - "type": "object" - } - } - } - } - }, - "deprecated": false - }, - "delete": { - "tags": ["Provider"], - "summary": "Delete GiftCard Provider by ID", - "description": "Delete a giftcard provider from a store.", - "operationId": "DeleteGiftCardProviderbyID", - "parameters": [ - { - "name": "Accept", - "in": "header", - "description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "The Media type of the body of the request. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "X-VTEX-API-AppKey", - "in": "header", - "description": "VTEX API AppKey", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppKey}}" - } - }, - { - "name": "X-VTEX-API-AppToken", - "in": "header", - "description": "VTEX API AppToken", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppToken}}" - } - }, - { - "name": "giftCardProviderID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "insert identifier here" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "text/plain": { - "schema": { - "type": "object" - } - } - } - }, - "404": { - "description": "O provider não existe.\n" - } - }, - "deprecated": false - } - }, - "/giftcardproviders/{giftCardProviderID}/giftcards": { - "post": { - "tags": ["Transaction"], - "summary": "Create GiftCard in GiftCard Provider", - "description": "Creates a giftcard in a giftcard provider.", - "operationId": "CreateGiftCardinGiftCardProvider", - "parameters": [ - { - "name": "Accept", - "in": "header", - "description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "The Media type of the body of the request. Default value for payment provider protocol is application/json", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "X-VTEX-API-AppKey", - "in": "header", - "description": "VTEX API AppKey", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppKey}}" - } - }, - { - "name": "X-VTEX-API-AppToken", - "in": "header", - "description": "VTEX API AppToken", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppToken}}" - } - }, - { - "name": "giftCardProviderID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "insert identifier here" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/vnd.vtex.giftcardproviders.v1+json": { - "schema": { - "$ref": "#/components/schemas/CreateGiftCardinGiftCardProviderRequest" - }, - "example": { - "relationName": "loyalty-program", - "emissionDate": "2011-02-04T17:02:19.17", - "expiringDate": "2020-02-04T17:02:19.17", - "caption": "Loyalty Program", - "restrictedToOwner": true, - "multipleRedemptions": true, - "multipleCredits": true, - "profileId": "92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "text/plain": { - "schema": { - "type": "object" - } - } - } - } - }, - "deprecated": false - } - }, - "/giftcardproviders/{giftCardProviderID}/giftcards/_search": { - "post": { - "tags": ["Transaction"], - "summary": "Get GiftCard from GiftCard Provider", - "description": "Returns all giftcards from a giftcard provider according to the filters.", - "operationId": "GetGiftCardfromGiftCardProvider", - "parameters": [ - { - "name": "Accept", - "in": "header", - "description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "The Media type of the body of the request. Default value for payment provider protocol is application/json", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "X-VTEX-API-AppKey", - "in": "header", - "description": "VTEX API AppKey", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppKey}}" - } - }, - { - "name": "X-VTEX-API-AppToken", - "in": "header", - "description": "VTEX API AppToken", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppToken}}" - } - }, - { - "name": "REST-Range", - "in": "header", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "resources=0-49" - } - }, - { - "name": "giftCardProviderID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "insert example here" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/vnd.vtex.giftcardproviders.v1+json": { - "schema": { - "$ref": "#/components/schemas/GetGiftCardfromGiftCardProviderRequest" - }, - "example": { - "client": { - "id": "3b1abc17-988e-4a14-8b7f-31fc6a5b955c", - "email": "email@domain.com", - "document": "42151783120" - }, - "cart": { - "grandTotal": 182, - "relationName": null, - "redemptionCode": null, - "discounts": -20, - "shipping": 2, - "taxes": 0, - "items": [ - { - "productId": "2000000", - "id": "2000002", - "refId": "MEV41", - "name": null, - "price": 200, - "quantity": 1 - } - ], - "itemsTotal": 200 - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "text/plain": { - "schema": { - "type": "object" - } - } - } - } - }, - "deprecated": false - } - }, - "/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}": { - "get": { - "tags": ["Transaction"], - "summary": "Get GiftCard from GiftCard Provider by ID", - "description": "Returns a specific giftcard from a giftcard provider.", - "operationId": "GetGiftCardfromGiftCardProviderbyID", - "parameters": [ - { - "name": "Accept", - "in": "header", - "description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "The Media type of the body of the request. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "X-VTEX-API-AppKey", - "in": "header", - "description": "VTEX API AppKey", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppKey}}" - } - }, - { - "name": "X-VTEX-API-AppToken", - "in": "header", - "description": "VTEX API AppToken", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppToken}}" - } - }, - { - "name": "giftCardProviderID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "insert identifier here" - } - }, - { - "name": "giftCardID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "6" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "text/plain": { - "schema": { - "type": "object" - } - } - } - } - }, - "deprecated": false - } - }, - "/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}/transactions": { - "get": { - "tags": ["Transaction"], - "summary": "List All GiftCard Transactions", - "description": "Return all transaction from a giftcard.", - "operationId": "ListAllGiftCardTransactions", - "parameters": [ - { - "name": "Accept", - "in": "header", - "description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "The Media type of the body of the request. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "X-VTEX-API-AppKey", - "in": "header", - "description": "VTEX API AppKey", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppKey}}" - } - }, - { - "name": "X-VTEX-API-AppToken", - "in": "header", - "description": "VTEX API AppToken", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppToken}}" - } - }, - { - "name": "giftCardProviderID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "insert identifier here" - } - }, - { - "name": "giftCardID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "6" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "text/plain": { - "schema": { - "type": "object" - } - } - } - } - }, - "deprecated": false - }, - "post": { - "tags": ["Transaction"], - "summary": "Create GiftCard Transaction", - "description": "Creates a transaction to a giftcard.", - "operationId": "CreateGiftCardTransaction", - "parameters": [ - { - "name": "Accept", - "in": "header", - "description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "The Media type of the body of the request. Default value for payment provider protocol is application/json", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "X-VTEX-API-AppKey", - "in": "header", - "description": "VTEX API AppKey", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppKey}}" - } - }, - { - "name": "X-VTEX-API-AppToken", - "in": "header", - "description": "VTEX API AppToken", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppToken}}" - } - }, - { - "name": "giftCardProviderID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "insert identifier here" - } - }, - { - "name": "giftCardID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "6" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/vnd.vtex.giftcardproviders.v1+json": { - "schema": { - "$ref": "#/components/schemas/CreateGiftCardTransactionRequest" - }, - "example": { - "operation": "Credit", - "value": 28.4, - "description": "Order v2915869org-01", - "redemptionToken": null, - "redemptionCode": null, - "requestId": "v2915869org-01", - "orderInfo": { - "orderId": "v2915869org-01", - "sequence": 2915869, - "cart": { - "items": [ - { - "id": "2000330", - "productId": "2000196", - "refId": null, - "name": "T-Shirt M", - "value": 15, - "price": 15, - "quantity": 1, - "shippingDiscount": 0, - "discount": 0, - "priceTags": [] - } - ], - "grandTotal": 0, - "discounts": 0, - "shipping": 0, - "taxes": 0, - "itemsTotal": 15 - }, - "clientProfile": { - "email": "email@domain.com", - "firstName": "John", - "lastName": "Smith", - "document": "10617764093", - "documentType": "cpf", - "phone": "+5521993759875", - "birthDate": "0001-01-01T00:00:00", - "isCorporate": false - }, - "shipping": { - "receiverName": "John Smith", - "postalCode": "24417-246", - "city": "Leblon", - "state": "RJ", - "country": "BRA", - "street": "Rua Aidea Barreto do Couto", - "number": "9678", - "neighborhood": "address", - "complement": "address", - "reference": "address" - } - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "text/plain": { - "schema": { - "type": "object" - } - } - } - } - }, - "deprecated": false - } - }, - "/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}/transactions/{transactionID}": { - "get": { - "tags": ["Transaction"], - "summary": "Get GiftCard Transaction by ID", - "description": "Returns a specific transaction from a giftcard.", - "operationId": "GetGiftCardTransactionbyID", - "parameters": [ - { - "name": "Accept", - "in": "header", - "description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "The Media type of the body of the request. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "X-VTEX-API-AppKey", - "in": "header", - "description": "VTEX API AppKey", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppKey}}" - } - }, - { - "name": "X-VTEX-API-AppToken", - "in": "header", - "description": "VTEX API AppToken", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppToken}}" - } - }, - { - "name": "giftCardProviderID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "insert identifier here" - } - }, - { - "name": "giftCardID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "6" - } - }, - { - "name": "transactionID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "b47690" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "text/plain": { - "schema": { - "type": "object" - } - } - } - } - }, - "deprecated": false - } - }, - "/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}/transactions/{transactionID}/authorization": { - "get": { - "tags": ["Transaction"], - "summary": "Get GiftCard Authorization Transaction", - "description": "Returns the transaction authorization info.", - "operationId": "GetGiftCardAuthorizationTransaction", - "parameters": [ - { - "name": "Accept", - "in": "header", - "description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "The Media type of the body of the request. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "X-VTEX-API-AppKey", - "in": "header", - "description": "VTEX API AppKey", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppKey}}" - } - }, - { - "name": "X-VTEX-API-AppToken", - "in": "header", - "description": "VTEX API AppToken", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppToken}}" - } - }, - { - "name": "giftCardProviderID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "insert identifier here" - } - }, - { - "name": "giftCardID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "6" - } - }, - { - "name": "transactionID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "b47690" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "text/plain": { - "schema": { - "type": "object" - } - } - } - } - }, - "deprecated": false - } - }, - "/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}/transactions/{transactionID}/settlements": { - "get": { - "tags": ["Transaction"], - "summary": "List All GiftCard Settlement Transactions", - "description": "Returns a collection of settlement transactions from a giftcard.", - "operationId": "ListAllGiftCardSettlementTransactions", - "parameters": [ - { - "name": "Accept", - "in": "header", - "description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "The Media type of the body of the request. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "X-VTEX-API-AppKey", - "in": "header", - "description": "VTEX API AppKey", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppKey}}" - } - }, - { - "name": "X-VTEX-API-AppToken", - "in": "header", - "description": "VTEX API AppToken", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppToken}}" - } - }, - { - "name": "giftCardProviderID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "insert identifier here" - } - }, - { - "name": "giftCardID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "6" - } - }, - { - "name": "transactionID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "b47690" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "text/plain": { - "schema": { - "type": "object" - } - } - } - } - }, - "deprecated": false - }, - "post": { - "tags": ["Transaction"], - "summary": "Create GiftCard Settlement Transaction", - "description": "Creates a settlement transaction to a giftcard.", - "operationId": "CreateGiftCardSettlementTransaction", - "parameters": [ - { - "name": "Accept", - "in": "header", - "description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "The Media type of the body of the request. Default value for payment provider protocol is application/json", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "giftCardProviderID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "insert identifier here" - } - }, - { - "name": "giftCardID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "6" - } - }, - { - "name": "transactionID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "b47690" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json;charset=utf-8": { - "schema": { - "$ref": "#/components/schemas/CreateGiftCardSettlementTransactionRequest" - }, - "example": { - "client": { - "id": "3b1abc17-988e-4a14-8b7f-31fc6a5b955c", - "email": "convidadovtex@gmail.com", - "document": "42151783120" - }, - "cart": { - "grandTotal": 182, - "relationName": "loyalty-program", - "redemptionCode": "FASD-ASDS-ASDA-ASDA", - "discounts": -20, - "shipping": 2, - "taxes": 0, - "items": [ - { - "productId": "2000000", - "id": "2000002", - "refId": "MEV41", - "name": null, - "price": 200, - "quantity": 1 - } - ], - "itemsTotal": 200 - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "text/plain": { - "schema": { - "type": "object" - } - } - } - } - }, - "deprecated": false - } - }, - "/giftcardproviders/{giftCardProviderID}/giftcards/{giftCardID}/transactions/{transactionID}/cancellations": { - "get": { - "tags": ["Transaction"], - "summary": "List All GiftCard Cancellation Transactions", - "description": "Returns a collection of cancellation transactions from a giftcard.", - "operationId": "ListAllGiftCardCancellationTransactions", - "parameters": [ - { - "name": "Accept", - "in": "header", - "description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "The Media type of the body of the request. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "X-VTEX-API-AppKey", - "in": "header", - "description": "VTEX API AppKey", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppKey}}" - } - }, - { - "name": "X-VTEX-API-AppToken", - "in": "header", - "description": "VTEX API AppToken", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppToken}}" - } - }, - { - "name": "giftCardProviderID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "insert identifier here" - } - }, - { - "name": "giftCardID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "6" - } - }, - { - "name": "transactionID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "b47690" - } - } - ], - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "text/plain": { - "schema": { - "type": "object" - } - } - } - } - }, - "deprecated": false - }, - "post": { - "tags": ["Transaction"], - "summary": "Create GiftCard Cancellation Transaction", - "description": "Creates a cancellation transaction to a giftcard.", - "operationId": "CreateGiftCardCancellationTransaction", - "parameters": [ - { - "name": "Accept", - "in": "header", - "description": "Media type(s) that is/are acceptable for the response. Default value for payment provider protocol is application/json.", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "Content-Type", - "in": "header", - "description": "The Media type of the body of the request. Default value for payment provider protocol is application/json", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "application/json" - } - }, - { - "name": "X-VTEX-API-AppKey", - "in": "header", - "description": "VTEX API AppKey", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppKey}}" - } - }, - { - "name": "X-VTEX-API-AppToken", - "in": "header", - "description": "VTEX API AppToken", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "{{X-VTEX-API-AppToken}}" - } - }, - { - "name": "giftCardProviderID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "insert identifier here" - } - }, - { - "name": "giftCardID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "6" - } - }, - { - "name": "transactionID", - "in": "path", - "description": "", - "required": true, - "style": "simple", - "schema": { - "type": "string", - "default": "b47690" - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/vnd.vtex.giftcardproviders.v1+json": { - "schema": { - "$ref": "#/components/schemas/CreateGiftCardCancellationTransactionRequest" - }, - "example": { - "value": 12.1, - "requestId": "12093812masoidj120398" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "", - "headers": {}, - "content": { - "text/plain": { - "schema": { - "type": "object" - } - } - } - } - }, - "deprecated": false - } - } - }, - "components": { - "schemas": { - "CreateUpdateGiftCardProviderbyIDRequest": { - "title": "", - "required": [ - "serviceUrl", - "oauthProvider", - "preAuthEnabled", - "cancelEnabled" - ], - "type": "object", - "properties": { - "serviceUrl": { - "type": "string", - "description": "URL from the provider" - }, - "oauthProvider": { - "type": "string", - "description": "Provider's authentication" - }, - "preAuthEnabled": { - "type": "boolean", - "description": "Related to the pre-authorization that can happen on the transaction generated through the provider" - }, - "cancelEnabled": { - "type": "boolean", - "description": "It says if it is possible to cancel the transaction, generated through the provider" - }, - "appKey": { - "type": "string", - "description": "Credential provided by the merchant that VTEX will use for identification" - }, - "appToken": { - "type": "string", - "description": "Credential provided by the merchant that VTEX will use for identification" - } - }, - "default": { - "serviceUrl": "https://api.vtex.com.br/example", - "oauthProvider": "vtex", - "preAuthEnabled": true, - "cancelEnabled": true - } - }, - "CreateGiftCardinGiftCardProviderRequest": { - "title": "CreateGiftCardinGiftCardProviderRequest", - "required": [ - "relationName", - "emissionDate", - "expiringDate", - "caption", - "restrictedToOwner", - "multipleRedemptions", - "multipleCredits", - "profileId" - ], - "type": "object", - "properties": { - "relationName": { - "type": "string" - }, - "emissionDate": { - "type": "string" - }, - "expiringDate": { - "type": "string" - }, - "caption": { - "type": "string" - }, - "restrictedToOwner": { - "type": "boolean" - }, - "multipleRedemptions": { - "type": "boolean" - }, - "multipleCredits": { - "type": "boolean" - }, - "profileId": { - "type": "string" - } - }, - "default": { - "relationName": "rewards-program", - "emissionDate": "2011-02-04T17:02:19.17", - "expiringDate": "2020-02-04T17:02:19.17", - "caption": "Rewards Program", - "restrictedToOwner": true, - "multipleRedemptions": true, - "multipleCredits": true, - "profileId": "92de2" - } - }, - "GetGiftCardfromGiftCardProviderRequest": { - "title": "GetGiftCardfromGiftCardProviderRequest", - "required": ["client", "cart"], - "type": "object", - "properties": { - "client": { - "$ref": "#/components/schemas/Client" - }, - "cart": { - "$ref": "#/components/schemas/Cart" - } - }, - "default": { - "client": { - "id": "3b1c", - "email": "email@domain.com", - "document": "42151783120" - }, - "cart": { - "grandTotal": 182, - "relationName": null, - "redemptionCode": null, - "discounts": 20, - "shipping": 2, - "taxes": 0, - "items": [ - { - "productId": "2000000", - "id": "2002", - "refId": "M41", - "name": null, - "price": 200, - "quantity": 1 - } - ], - "itemsTotal": 200 - } - } - }, - "Client": { - "title": "Client", - "required": ["id", "email", "document"], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "email": { - "type": "string" - }, - "document": { - "type": "string" - } - }, - "default": { - "id": "3b1ab", - "email": "email@domain.com", - "document": "42151783120" - } - }, - "Cart": { - "title": "Cart", - "required": [ - "grandTotal", - "relationName", - "redemptionCode", - "discounts", - "shipping", - "taxes", - "items", - "itemsTotal" - ], - "type": "object", - "properties": { - "grandTotal": { - "type": "integer", - "format": "int32" - }, - "relationName": { - "type": "string", - "nullable": true - }, - "redemptionCode": { - "type": "string", - "nullable": true - }, - "discounts": { - "type": "integer", - "format": "int32" - }, - "shipping": { - "type": "integer", - "format": "int32" - }, - "taxes": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Item" - }, - "description": "" - }, - "itemsTotal": { - "type": "integer", - "format": "int32" - } - }, - "example": { - "grandTotal": 182, - "relationName": null, - "redemptionCode": null, - "discounts": 20, - "shipping": 2, - "taxes": 0, - "items": [ - { - "productId": "2000000", - "id": "2000002", - "refId": "MEV41", - "name": null, - "price": 200, - "quantity": 1 - } - ], - "itemsTotal": 200 - } - }, - "Item": { - "title": "Item", - "required": [ - "productId", - "id", - "refId", - "name", - "price", - "quantity" - ], - "type": "object", - "properties": { - "productId": { - "type": "string" - }, - "id": { - "type": "string" - }, - "refId": { - "type": "string" - }, - "name": { - "type": "string", - "nullable": true - }, - "price": { - "type": "integer", - "format": "int32" - }, - "quantity": { - "type": "integer", - "format": "int32" - } - }, - "default": { - "productId": "2000000", - "id": "2000002", - "refId": "MEV41", - "name": null, - "price": 200, - "quantity": 1 - } - }, - "CreateGiftCardTransactionRequest": { - "title": "CreateGiftCardTransactionRequest", - "required": [ - "operation", - "value", - "description", - "redemptionToken", - "redemptionCode", - "requestId", - "orderInfo" - ], - "type": "object", - "properties": { - "operation": { - "type": "string" - }, - "value": { - "type": "number" - }, - "description": { - "type": "string" - }, - "redemptionToken": { - "type": "string" - }, - "redemptionCode": { - "type": "string", - "nullable": true - }, - "requestId": { - "type": "string" - }, - "orderInfo": { - "$ref": "#/components/schemas/OrderInfo" - } - }, - "default": { - "operation": "Credit", - "value": 28, - "description": "example", - "redemptionToken": null, - "redemptionCode": null, - "requestId": "v2915", - "orderInfo": { - "orderId": "v2915", - "sequence": 2915869, - "cart": { - "items": [ - { - "id": "2000330", - "productId": "2000196", - "refId": null, - "name": "n", - "value": 15, - "price": 15, - "quantity": 1, - "shippingDiscount": 0, - "discount": 0, - "priceTags": [] - } - ], - "grandTotal": 0, - "discounts": 0, - "shipping": 0, - "taxes": 0, - "itemsTotal": 15 - }, - "clientProfile": { - "email": "email@domain.com", - "firstName": "example", - "lastName": "example", - "document": "10617764093", - "documentType": "cpf", - "phone": "+5521999999999", - "birthDate": "0001-01-01T00:00:00", - "isCorporate": false - }, - "shipping": { - "receiverName": "client", - "postalCode": "24417-246", - "city": "Rio de Janeiro", - "state": "RJ", - "country": "BRA", - "street": "address", - "number": "96", - "neighborhood": "address", - "complement": "address", - "reference": "address" - } - } - } - }, - "OrderInfo": { - "title": "OrderInfo", - "required": [ - "orderId", - "sequence", - "cart", - "clientProfile", - "shipping" - ], - "type": "object", - "properties": { - "orderId": { - "type": "string" - }, - "sequence": { - "type": "integer", - "format": "int32" - }, - "cart": { - "$ref": "#/components/schemas/Cart1" - }, - "clientProfile": { - "$ref": "#/components/schemas/ClientProfile" - }, - "shipping": { - "$ref": "#/components/schemas/Shipping" - } - }, - "example": { - "orderId": "v2915869org-01", - "sequence": 2915869, - "cart": { - "items": [ - { - "id": "2000330", - "productId": "2000196", - "refId": null, - "name": "T-Shirt M", - "value": 15, - "price": 15, - "quantity": 1, - "shippingDiscount": 0, - "discount": 0, - "priceTags": [] - } - ], - "grandTotal": 0, - "discounts": 0, - "shipping": 0, - "taxes": 0, - "itemsTotal": 15 - }, - "clientProfile": { - "email": "email@domain.com", - "firstName": "John", - "lastName": "Smith", - "document": "10617764093", - "documentType": "cpf", - "phone": "+5521993759875", - "birthDate": "0001-01-01T00:00:00", - "isCorporate": false - }, - "shipping": { - "receiverName": "John Smith", - "postalCode": "24417-246", - "city": "Leblon", - "state": "RJ", - "country": "BRA", - "street": "Rua Aidea Barreto do Couto", - "number": "9678", - "neighborhood": "", - "complement": "", - "reference": "" - } - } - }, - "Cart1": { - "title": "Cart1", - "required": [ - "items", - "grandTotal", - "discounts", - "shipping", - "taxes", - "itemsTotal" - ], - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Item1" - }, - "description": "" - }, - "grandTotal": { - "type": "integer", - "format": "int32" - }, - "discounts": { - "type": "integer", - "format": "int32" - }, - "shipping": { - "type": "integer", - "format": "int32" - }, - "taxes": { - "type": "integer", - "format": "int32" - }, - "itemsTotal": { - "type": "integer", - "format": "int32" - } - }, - "example": { - "items": [ - { - "id": "2000330", - "productId": "2000196", - "refId": null, - "name": "T-Shirt M", - "value": 15, - "price": 15, - "quantity": 1, - "shippingDiscount": 0, - "discount": 0, - "priceTags": [] - } - ], - "grandTotal": 0, - "discounts": 0, - "shipping": 0, - "taxes": 0, - "itemsTotal": 15 - } - }, - "Item1": { - "title": "Item1", - "required": [ - "id", - "productId", - "refId", - "name", - "value", - "price", - "quantity", - "shippingDiscount", - "discount", - "priceTags" - ], - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "productId": { - "type": "string" - }, - "refId": { - "type": "string", - "nullable": true - }, - "name": { - "type": "string" - }, - "value": { - "type": "integer", - "format": "int32" - }, - "price": { - "type": "integer", - "format": "int32" - }, - "quantity": { - "type": "integer", - "format": "int32" - }, - "shippingDiscount": { - "type": "integer", - "format": "int32" - }, - "discount": { - "type": "integer", - "format": "int32" - }, - "priceTags": { - "type": "array", - "items": { - "type": "string" - }, - "description": "" - } - }, - "example": { - "id": "2000330", - "productId": "2000196", - "refId": null, - "name": "T-Shirt M", - "value": 15, - "price": 15, - "quantity": 1, - "shippingDiscount": 0, - "discount": 0, - "priceTags": [] - } - }, - "ClientProfile": { - "title": "ClientProfile", - "required": [ - "email", - "firstName", - "lastName", - "document", - "documentType", - "phone", - "birthDate", - "isCorporate" - ], - "type": "object", - "properties": { - "email": { - "type": "string" - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "document": { - "type": "string" - }, - "documentType": { - "type": "string" - }, - "phone": { - "type": "string" - }, - "birthDate": { - "type": "string" - }, - "isCorporate": { - "type": "boolean" - } - }, - "example": { - "email": "email@domain.com", - "firstName": "John", - "lastName": "Smith", - "document": "10617764093", - "documentType": "cpf", - "phone": "+5521993759875", - "birthDate": "0001-01-01T00:00:00", - "isCorporate": false - } - }, - "Shipping": { - "title": "Shipping", - "required": [ - "receiverName", - "postalCode", - "city", - "state", - "country", - "street", - "number", - "neighborhood", - "complement", - "reference" - ], - "type": "object", - "properties": { - "receiverName": { - "type": "string" - }, - "postalCode": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "country": { - "type": "string" - }, - "street": { - "type": "string" - }, - "number": { - "type": "string" - }, - "neighborhood": { - "type": "string" - }, - "complement": { - "type": "string" - }, - "reference": { - "type": "string" - } - }, - "example": { - "receiverName": "John Smith", - "postalCode": "24417-246", - "city": "Leblon", - "state": "RJ", - "country": "BRA", - "street": "Rua Aidea Barreto do Couto", - "number": "9678", - "neighborhood": "", - "complement": "", - "reference": "" - } - }, - "CreateGiftCardSettlementTransactionRequest": { - "title": "CreateGiftCardSettlementTransactionRequest", - "required": ["client", "cart"], - "type": "object", - "properties": { - "client": { - "$ref": "#/components/schemas/Client" - }, - "cart": { - "$ref": "#/components/schemas/Cart2" - } - }, - "default": { - "client": { - "id": "3b1abc17-988e-4a14-8b7f-31fc6a5b955c", - "email": "convidadovtex@gmail.com", - "document": "42151783120" - }, - "cart": { - "grandTotal": 182, - "relationName": "rewards-program", - "redemptionCode": "FASD", - "discounts": 20, - "shipping": 2, - "taxes": 0, - "items": [ - { - "productId": "200", - "id": "2002", - "refId": "MEV41", - "name": null, - "price": 200, - "quantity": 1 - } - ], - "itemsTotal": 200 - } - } - }, - "Cart2": { - "title": "Cart2", - "required": [ - "grandTotal", - "relationName", - "redemptionCode", - "discounts", - "shipping", - "taxes", - "items", - "itemsTotal" - ], - "type": "object", - "properties": { - "grandTotal": { - "type": "integer", - "format": "int32" - }, - "relationName": { - "type": "string" - }, - "redemptionCode": { - "type": "string" - }, - "discounts": { - "type": "integer", - "format": "int32" - }, - "shipping": { - "type": "integer", - "format": "int32" - }, - "taxes": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Item" - }, - "description": "" - }, - "itemsTotal": { - "type": "integer", - "format": "int32" - } - }, - "example": { - "grandTotal": 182, - "relationName": "loyalty-program", - "redemptionCode": "FASD-ASDS-ASDA-ASDA", - "discounts": -20, - "shipping": 2, - "taxes": 0, - "items": [ - { - "productId": "2000000", - "id": "2000002", - "refId": "MEV41", - "name": null, - "price": 200, - "quantity": 1 - } - ], - "itemsTotal": 200 - } - }, - "CreateGiftCardCancellationTransactionRequest": { - "title": "CreateGiftCardCancellationTransactionRequest", - "required": ["value", "requestId"], - "type": "object", - "properties": { - "value": { - "type": "number" - }, - "requestId": { - "type": "string" - } - }, - "default": { - "value": 12, - "requestId": "1209" - } - } - }, - "securitySchemes": { - "appKey": { - "type": "apiKey", - "in": "header", - "name": "X-VTEX-API-AppKey" - }, - "appToken": { - "type": "apiKey", - "in": "header", - "name": "X-VTEX-API-AppToken" - } - } - }, - "tags": [ - { - "name": "Provider", - "description": "" - }, - { - "name": "Transaction", - "description": "" - } - ], - "security": [ - { - "appKey": [], - "appToken": [] - } - ] -} \ No newline at end of file diff --git a/src/pages/api/disable-preview.ts b/src/pages/api/disable-preview.ts deleted file mode 100644 index 5462b48e..00000000 --- a/src/pages/api/disable-preview.ts +++ /dev/null @@ -1,6 +0,0 @@ -import { NextApiRequest, NextApiResponse } from 'next' - -export default function handler(_req: NextApiRequest, res: NextApiResponse) { - res.clearPreviewData({}) - res.redirect('/') -} diff --git a/src/pages/api/docs.ts b/src/pages/api/docs.ts deleted file mode 100644 index b03f2c17..00000000 --- a/src/pages/api/docs.ts +++ /dev/null @@ -1,6 +0,0 @@ -import { getAllDocsPaths } from 'utils/getDocsPaths' -//eslint-disable-next-line @typescript-eslint/no-explicit-any -export default async function handler(req: any, res: any) { - req = req - res.status(200).json(await getAllDocsPaths()) -} diff --git a/src/pages/api/feedback.ts b/src/pages/api/feedback.ts deleted file mode 100644 index 166640a4..00000000 --- a/src/pages/api/feedback.ts +++ /dev/null @@ -1,54 +0,0 @@ -import { Compute, JWT, UserRefreshClient } from 'google-auth-library' -import { google } from 'googleapis' -import { getVariable } from 'utils/get-variables' - -const SCOPES = ['https://www.googleapis.com/auth/spreadsheets'] - -function writeData( - auth: Compute | JWT | UserRefreshClient, - data: string[], - // eslint-disable-next-line @typescript-eslint/no-explicit-any - res: any -) { - const sheets = google.sheets({ version: 'v4', auth }) - const values = [data] - let error, response - - sheets.spreadsheets.values.append( - { - spreadsheetId: getVariable('SPREADSHEET_ID'), - range: 'Sheet1!A1:A5', - valueInputOption: 'RAW', - requestBody: { values }, - }, - (err, result) => { - if (err) res.status(400).json(err) - else res.status(200).json(result) - } - ) - - return { error, response } -} - -async function getAuth() { - const jwt = new google.auth.JWT( - getVariable('GOOGLE_SHEETS_CLIENT_EMAIL'), - undefined, - (getVariable('GOOGLE_SHEETS_PRIVATE_KEY') || '').replace(/\\n/g, '\n'), - SCOPES - ) - - return jwt -} - -//eslint-disable-next-line @typescript-eslint/no-explicit-any -export default async function handler(req: any, res: any) { - let data: string[] = [] - try { - data = JSON.parse(req.body).data - const auth = await getAuth() - writeData(auth, data, res) - } catch (err) { - res.status(400).json(err) - } -} diff --git a/src/pages/api/navigation.ts b/src/pages/api/navigation.ts deleted file mode 100644 index dad9b44a..00000000 --- a/src/pages/api/navigation.ts +++ /dev/null @@ -1,14 +0,0 @@ -import getNavigation from 'utils/getNavigation' - -//eslint-disable-next-line @typescript-eslint/no-explicit-any -export default async function handler(req: any, res: any) { - req = req - const sidebarDataMaster = await getNavigation() - res - .status(200) - .setHeader( - 'Cache-Control', - 'public, s-maxage=300, stale-while-revalidate=250' - ) - .json(sidebarDataMaster) -} diff --git a/src/pages/api/openapi/[slug].tsx b/src/pages/api/openapi/[slug].tsx deleted file mode 100644 index e2921e1b..00000000 --- a/src/pages/api/openapi/[slug].tsx +++ /dev/null @@ -1,87 +0,0 @@ -export const config = { - api: { - bodyParser: false, - }, -} - -const referencePaths = objectFlip({ - 'VTEX - Antifraud Provider API': 'antifraud-provider-protocol', - 'VTEX - CMS API': 'cms-api', - 'VTEX - Catalog API Seller Portal': 'catalog-api-seller-portal', - 'VTEX - Catalog API': 'catalog-api', - 'VTEX - Checkout API': 'checkout-api', - 'VTEX - Customer Credit API': 'customer-credit-api', - 'VTEX - GiftCard Hub API': 'giftcard-hub-api', - 'VTEX - Giftcard API': 'giftcard-api', - 'VTEX - Giftcard Provider Protocol': 'giftcard-provider-protocol', - 'VTEX - Headless CMS API': 'headless-cms-api', - 'VTEX - Intelligent Search API': 'intelligent-search-api', - 'VTEX - License Manager API': 'license-manager-api', - 'VTEX - Logistics API': 'logistics-api', - 'VTEX - Marketplace APIs': 'marketplace-apis', - 'VTEX - Marketplace APIs - Suggestions': 'marketplace-apis-suggestions', - 'VTEX - Marketplace APIs - Sent Offers': 'marketplace-apis-offer-management', - 'VTEX - Marketplace Protocol - External Marketplace Mapper': - 'marketplace-protocol-external-marketplace-mapper', - 'VTEX - Marketplace Protocol - External Marketplace Orders': - 'marketplace-protocol-external-marketplace-orders', - 'VTEX - Marketplace Protocol - External Seller Fulfillment': - 'marketplace-protocol-external-seller-fulfillment', - 'VTEX - Marketplace Protocol - External Seller Marketplace': - 'marketplace-protocol', - 'VTEX - Master Data API - v2': 'master-data-api-v2', - 'VTEX - MasterData API - v10.2': 'masterdata-api', - 'VTEX - Message Center API': 'message-center-api', - 'VTEX - Orders API (PII version)': 'orders-api-pii-version', - 'VTEX - Orders API': 'orders-api', - 'VTEX - Payment Provider Protocol': 'payment-provider-protocol', - 'VTEX - Payments Gateway API': 'payments-gateway-api', - 'VTEX - Policies System API': 'policies-system-api', - 'VTEX - Price Simulations': 'price-simulations', - 'VTEX - Pricing API': 'pricing-api', - 'VTEX - Pricing Hub': 'pricing-hub', - 'VTEX - Profile System': 'profile-system', - 'VTEX - Promotions & Taxes API': 'promotions-and-taxes-api', - 'VTEX - Recurrence (v1 - deprecated)': 'recurrence-v1-deprecated', - 'VTEX - Reviews and Ratings API': 'reviews-and-ratings-api', - 'VTEX - SKU Bindings API': 'sku-bindings-api', - 'VTEX - Search API': 'search-api', - 'VTEX - Session Manager API': 'session-manager-api', - 'VTEX - Subscriptions API (v2)': 'subscriptions-api-v2', - 'VTEX - Subscriptions API (v3)': 'subscriptions-api-v3', - 'VTEX - Tracking': 'tracking', - 'VTEX - VTEX Do API': 'vtex-do-api', - 'VTEX - VTEX ID API': 'vtex-id-api', - 'VTEX - VTEX Shipping Network API': 'vtex-shipping-network-api', -}) - -function objectFlip(obj: { [x: string]: string }) { - return Object.keys(obj).reduce((ret, key) => { - // eslint-disable-next-line @typescript-eslint/ban-ts-comment - // @ts-ignore - ret[obj[key]] = key - return ret - }, {}) -} - -// eslint-disable-next-line @typescript-eslint/no-explicit-any -export default async function handler(req: any, res: any) { - const { slug } = req.query - // eslint-disable-next-line @typescript-eslint/ban-ts-comment - // @ts-ignore - const path = referencePaths[slug] || '' - if (path) { - const response = await fetch( - `https://raw.githubusercontent.com/vtex/openapi-schemas/master/${path}.json` - ) - const body = await response.text() - res - .setHeader( - 'Cache-Control', - 'public, s-maxage=300, stale-while-revalidate=250' - ) - .send(body) - } else { - res.status(404) - } -} diff --git a/src/pages/api/preview.ts b/src/pages/api/preview.ts deleted file mode 100644 index b6de5598..00000000 --- a/src/pages/api/preview.ts +++ /dev/null @@ -1,43 +0,0 @@ -import { NextApiRequest, NextApiResponse } from 'next' -import octokit from 'utils/octokitConfig' - -async function getGithubBranch(org: string, repo: string, branch: string) { - const response = octokit.request( - 'GET /repos/{owner}/{repo}/branches/{branch}', - { - owner: org, - repo: repo, - branch: branch, - } - ) - const branchExists = (await response).status == 200 ? true : false - - return branchExists -} - -export default async function handler( - req: NextApiRequest, - res: NextApiResponse -) { - const branch = req.query.branch ? (req.query.branch as string) : 'main' - - if (req.query.branch) { - let branchExists - try { - branchExists = await getGithubBranch( - 'vtexdocs', - 'help-center-content', - branch - ) - } catch { - branchExists = false - } - if (branchExists) { - const customPreviewData = { - branch: `${branch}`, - } - res.setPreviewData(customPreviewData) - } - } - res.redirect('/') -} diff --git a/src/pages/api/proxy/[url].ts b/src/pages/api/proxy/[url].ts deleted file mode 100644 index 6117d49f..00000000 --- a/src/pages/api/proxy/[url].ts +++ /dev/null @@ -1,48 +0,0 @@ -import httpProxy from 'http-proxy' - -// Make sure that we don't parse JSON bodies on this route: -export const config = { - api: { - // Enable `externalResolver` option in Next.js - externalResolver: true, - bodyParser: false, - }, -} -// eslint-disable-next-line @typescript-eslint/no-explicit-any -function enableCors(req: any, res: any) { - if (req.headers['access-control-request-method']) { - res.setHeader( - 'access-control-allow-methods', - req.headers['access-control-request-method'] - ) - } - - if (req.headers['access-control-request-headers']) { - res.setHeader( - 'access-control-allow-headers', - req.headers['access-control-request-headers'] - ) - } - - if (req.headers.origin) { - res.setHeader('access-control-allow-origin', req.headers.origin) - res.setHeader('access-control-allow-credentials', 'true') - } -} -// eslint-disable-next-line @typescript-eslint/no-explicit-any -export default (req: any, res: any) => - new Promise((resolve, reject) => { - const { url } = req.query - const proxy: httpProxy = httpProxy.createProxy() - proxy.on('proxyRes', function (proxyRes, req, res) { - // eslint-disable-next-line @typescript-eslint/no-unused-vars - res = res - enableCors(req, proxyRes) - }) - proxy.once('proxyRes', resolve).once('error', reject).web(req, res, { - target: url, - ignorePath: true, - changeOrigin: true, - followRedirects: false, - }) - }) diff --git a/src/pages/api/revalidate.ts b/src/pages/api/revalidate.ts deleted file mode 100644 index be6d9481..00000000 --- a/src/pages/api/revalidate.ts +++ /dev/null @@ -1,15 +0,0 @@ -// eslint-disable-next-line @typescript-eslint/no-explicit-any -export default async function handler(req: any, res: any) { - if (req.query.secret !== process.env.REVALIDATE_SECRET) { - return res.status(401).json({ message: 'Invalid token' }) - } - - try { - if (req.query.url) { - await res.revalidate(req.query.url) - return res.json({ revalidated: true }) - } - } catch (err) { - return res.status(500).send('Error revalidating') - } -} diff --git a/src/styles/api-guides.ts b/src/styles/api-guides.ts deleted file mode 100644 index fe0b3471..00000000 --- a/src/styles/api-guides.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { SxStyleProp } from '@vtex/brand-ui' - -const container: SxStyleProp = { - pt: '5rem', - background: '#FFFFFF', -} - -export default { - container, -} diff --git a/src/styles/apps-page.ts b/src/styles/apps-page.ts deleted file mode 100644 index d0ebdc77..00000000 --- a/src/styles/apps-page.ts +++ /dev/null @@ -1,19 +0,0 @@ -import { SxStyleProp } from '@vtex/brand-ui' - -const details: SxStyleProp = { - color: '#6b7785', - gap: '30px', - fontSize: '16px', - mt: '12px', - mb: '18px', -} - -const iconDetails: SxStyleProp = { - mr: '3px', - alignSelf: 'center', -} - -export default { - details, - iconDetails, -} diff --git a/src/styles/global.css b/src/styles/global.css index 0508b185..e35a34f9 100644 --- a/src/styles/global.css +++ b/src/styles/global.css @@ -77,38 +77,3 @@ table th { table tbody tr:nth-of-type(even) { background-color: #f8f7fc; } - -.api { - box-sizing: border-box; - margin: 0px 4px; - border: 1px solid #dddddd; - background: #f4f4f4; - border-radius: 2px; - width: max-content; - height: 24px; - padding-left: 4px; - padding-right: 4px; - display: inline-block; - font-size: 12px; - font-weight: 600; -} - -.api.type-post { - color: #2978b5; -} - -.api.type-get { - color: #38853c; -} - -.api.type-put { - color: #d56a00; -} - -.api.type-delete { - color: #cc3d3d; -} - -.api.type-patch { - color: #827717; -} diff --git a/src/styles/release-notes.ts b/src/styles/release-notes.ts deleted file mode 100644 index 9610c5b1..00000000 --- a/src/styles/release-notes.ts +++ /dev/null @@ -1,9 +0,0 @@ -import { SxStyleProp } from '@vtex/brand-ui' - -const container: SxStyleProp = { - background: '#FFFFFF', -} - -export default { - container, -} diff --git a/src/utils/getReferencePaths.ts b/src/utils/getReferencePaths.ts deleted file mode 100644 index 222b13c4..00000000 --- a/src/utils/getReferencePaths.ts +++ /dev/null @@ -1,98 +0,0 @@ -/* eslint-disable @typescript-eslint/no-explicit-any */ -const referencePaths: { [slug: string]: string } = {} - -import octokit from 'utils/octokitConfig' -import { getLogger } from './logging/log-util' - -async function getGithubTree(org: string, repo: string, ref: string) { - const response = octokit.request( - 'GET /repos/{org}/{repo}/git/trees/{ref}?recursive=true', - { - org: org, - repo: repo, - ref: ref, - } - ) - - return (await response).data -} - -const fileSlugMap = { - 'VTEX - Antifraud Provider API': 'antifraud-provider-protocol', - 'VTEX - CMS API': 'cms-api', - 'VTEX - Catalog API Seller Portal': 'catalog-api-seller-portal', - 'VTEX - Catalog API': 'catalog-api', - 'VTEX - Checkout API': 'checkout-api', - 'VTEX - Customer Credit API': 'customer-credit-api', - 'VTEX - GiftCard Hub API': 'giftcard-hub-api', - 'VTEX - Giftcard API': 'giftcard-api', - 'VTEX - Giftcard Provider Protocol': 'giftcard-provider-protocol', - 'VTEX - Headless CMS API': 'headless-cms-api', - 'VTEX - Intelligent Search API': 'intelligent-search-api', - 'VTEX - License Manager API': 'license-manager-api', - 'VTEX - Logistics API': 'logistics-api', - 'VTEX - Marketplace APIs': 'marketplace-apis', - 'VTEX - Marketplace APIs - Suggestions': 'marketplace-apis-suggestions', - 'VTEX - Marketplace APIs - Sent Offers': 'marketplace-apis-offer-management', - 'VTEX - Marketplace Protocol - External Marketplace Mapper': - 'marketplace-protocol-external-marketplace-mapper', - 'VTEX - Marketplace Protocol - External Marketplace Orders': - 'marketplace-protocol-external-marketplace-orders', - 'VTEX - Marketplace Protocol - External Seller Fulfillment': - 'marketplace-protocol-external-seller-fulfillment', - 'VTEX - Marketplace Protocol - External Seller Marketplace': - 'marketplace-protocol', - 'VTEX - Master Data API - v2': 'master-data-api-v2', - 'VTEX - MasterData API - v10.2': 'masterdata-api', - 'VTEX - Message Center API': 'message-center-api', - 'VTEX - Orders API (PII version)': 'orders-api-pii-version', - 'VTEX - Orders API': 'orders-api', - 'VTEX - Payment Provider Protocol': 'payment-provider-protocol', - 'VTEX - Payments Gateway API': 'payments-gateway-api', - 'VTEX - Policies System API': 'policies-system-api', - 'VTEX - Price Simulations': 'price-simulations', - 'VTEX - Pricing API': 'pricing-api', - 'VTEX - Pricing Hub': 'pricing-hub', - 'VTEX - Profile System': 'profile-system', - 'VTEX - Promotions & Taxes API': 'promotions-and-taxes-api', - 'VTEX - Recurrence (v1 - deprecated)': 'recurrence-v1-deprecated', - 'VTEX - Reviews and Ratings API': 'reviews-and-ratings-api', - 'VTEX - SKU Bindings API': 'sku-bindings-api', - 'VTEX - Search API': 'search-api', - 'VTEX - Session Manager API': 'session-manager-api', - 'VTEX - Subscriptions API (v2)': 'subscriptions-api-v2', - 'VTEX - Subscriptions API (v3)': 'subscriptions-api-v3', - 'VTEX - Tracking': 'tracking', - 'VTEX - VTEX Do API': 'vtex-do-api', - 'VTEX - VTEX ID API': 'vtex-id-api', - 'VTEX - VTEX Shipping Network API': 'vtex-shipping-network-api', -} - -export default async function getReferencePaths() { - const logger = getLogger('getReferencePaths') - const repoTree = await getGithubTree('vtex', 'openapi-schemas', 'master') - repoTree.tree.map((node: any) => { - const path = node.path - const re = /^(?.+\/)*(?.+)\.(?.+)$/ - if (path.startsWith('')) { - const match = path.match(re) - const filename = match?.groups?.filename ? match?.groups?.filename : '' - const filetype = match?.groups?.filetype ? match?.groups?.filetype : '' - // eslint-disable-next-line @typescript-eslint/ban-ts-comment - // @ts-ignore - const fileslug = fileSlugMap[filename as string] - if (filetype === 'json' && filename !== 'VTEX_TEMPLATE') { - if (!fileslug) - logger.error( - `Couldn't find slug for this file: ${filename} in ${path}` - ) - else - (referencePaths as any)[ - fileslug - ] = `https://cdn.jsdelivr.net/gh/vtex/openapi-schemas/${path}` - } - } - }) - - return referencePaths -}