From aa00c0fa2649be4c22ee888a685874e59877a50b Mon Sep 17 00:00:00 2001 From: Tiago Gimenes Date: Fri, 12 Jan 2024 21:29:55 -0300 Subject: [PATCH] feat: add vision to openai (#304) --- admin/actions/code/vision.ts | 12 + admin/manifest.gen.ts | 38 +- admin/mod.ts | 5 +- openai/loaders/vision.ts | 46 + openai/manifest.gen.ts | 5 + vtex/utils/openapi/vcs.openapi.gen.ts | 7198 ++++++++++++------------- 6 files changed, 3655 insertions(+), 3649 deletions(-) create mode 100644 admin/actions/code/vision.ts create mode 100644 openai/loaders/vision.ts diff --git a/admin/actions/code/vision.ts b/admin/actions/code/vision.ts new file mode 100644 index 000000000..4345cdab8 --- /dev/null +++ b/admin/actions/code/vision.ts @@ -0,0 +1,12 @@ +import { type Props } from "../../../openai/loaders/vision.ts"; +import { AppContext } from "../../mod.ts"; + +export default async function action( + props: Props, + _req: Request, + ctx: AppContext, +): Promise { + const response = await ctx.invoke("openai/loaders/vision.ts", props); + + return response.choices?.[0]?.message.content; +} diff --git a/admin/manifest.gen.ts b/admin/manifest.gen.ts index 527faf849..53a273741 100644 --- a/admin/manifest.gen.ts +++ b/admin/manifest.gen.ts @@ -19,15 +19,16 @@ import * as $$$$$$$$$2 from "./actions/blocks/safeDelete.ts"; import * as $$$$$$$$$3 from "./actions/blocks/newRevision.ts"; import * as $$$$$$$$$4 from "./actions/blocks/delete.ts"; import * as $$$$$$$$$5 from "./actions/releases/fork.ts"; -import * as $$$$$$$$$6 from "./actions/code/suggestions.ts"; -import * as $$$$$$$$$7 from "./actions/sites/linkRepo.ts"; -import * as $$$$$$$$$8 from "./actions/sites/newDomain.ts"; -import * as $$$$$$$$$9 from "./actions/sites/unlinkRepo.ts"; -import * as $$$$$$$$$10 from "./actions/github/setStatus.ts"; -import * as $$$$$$$$$11 from "./actions/github/webhooks/broker.ts"; -import * as $$$$$$$$$12 from "./actions/pages/publish.ts"; -import * as $$$$$$$$$13 from "./actions/pages/new.ts"; -import * as $$$$$$$$$14 from "./actions/pages/delete.ts"; +import * as $$$$$$$$$6 from "./actions/code/vision.ts"; +import * as $$$$$$$$$7 from "./actions/code/suggestions.ts"; +import * as $$$$$$$$$8 from "./actions/sites/linkRepo.ts"; +import * as $$$$$$$$$9 from "./actions/sites/newDomain.ts"; +import * as $$$$$$$$$10 from "./actions/sites/unlinkRepo.ts"; +import * as $$$$$$$$$11 from "./actions/github/setStatus.ts"; +import * as $$$$$$$$$12 from "./actions/github/webhooks/broker.ts"; +import * as $$$$$$$$$13 from "./actions/pages/publish.ts"; +import * as $$$$$$$$$14 from "./actions/pages/new.ts"; +import * as $$$$$$$$$15 from "./actions/pages/delete.ts"; const manifest = { "loaders": { @@ -49,16 +50,17 @@ const manifest = { "deco-sites/admin/actions/blocks/publish.ts": $$$$$$$$$0, "deco-sites/admin/actions/blocks/restore.ts": $$$$$$$$$1, "deco-sites/admin/actions/blocks/safeDelete.ts": $$$$$$$$$2, - "deco-sites/admin/actions/code/suggestions.ts": $$$$$$$$$6, - "deco-sites/admin/actions/github/setStatus.ts": $$$$$$$$$10, - "deco-sites/admin/actions/github/webhooks/broker.ts": $$$$$$$$$11, - "deco-sites/admin/actions/pages/delete.ts": $$$$$$$$$14, - "deco-sites/admin/actions/pages/new.ts": $$$$$$$$$13, - "deco-sites/admin/actions/pages/publish.ts": $$$$$$$$$12, + "deco-sites/admin/actions/code/suggestions.ts": $$$$$$$$$7, + "deco-sites/admin/actions/code/vision.ts": $$$$$$$$$6, + "deco-sites/admin/actions/github/setStatus.ts": $$$$$$$$$11, + "deco-sites/admin/actions/github/webhooks/broker.ts": $$$$$$$$$12, + "deco-sites/admin/actions/pages/delete.ts": $$$$$$$$$15, + "deco-sites/admin/actions/pages/new.ts": $$$$$$$$$14, + "deco-sites/admin/actions/pages/publish.ts": $$$$$$$$$13, "deco-sites/admin/actions/releases/fork.ts": $$$$$$$$$5, - "deco-sites/admin/actions/sites/linkRepo.ts": $$$$$$$$$7, - "deco-sites/admin/actions/sites/newDomain.ts": $$$$$$$$$8, - "deco-sites/admin/actions/sites/unlinkRepo.ts": $$$$$$$$$9, + "deco-sites/admin/actions/sites/linkRepo.ts": $$$$$$$$$8, + "deco-sites/admin/actions/sites/newDomain.ts": $$$$$$$$$9, + "deco-sites/admin/actions/sites/unlinkRepo.ts": $$$$$$$$$10, }, "name": "deco-sites/admin", "baseUrl": import.meta.url, diff --git a/admin/mod.ts b/admin/mod.ts index 86048cae0..3d8a50607 100644 --- a/admin/mod.ts +++ b/admin/mod.ts @@ -15,6 +15,7 @@ import { pushEventHandler } from "./github/push.ts"; import { State as Resolvables } from "./loaders/state.ts"; import manifest, { Manifest as AppManifest } from "./manifest.gen.ts"; import { Manifest as AIAssistantManifest } from "../ai-assistants/manifest.gen.ts"; +import { Manifest as OpenAIManifest } from "../openai/manifest.gen.ts"; export const ANONYMOUS = "Anonymous"; export interface BlockStore extends Release { @@ -125,7 +126,9 @@ export default function App( } export type AppContext = AC< - Omit, "dependencies"> & ReturnType + & Omit, "dependencies"> + & Omit, "dependencies"> + & ReturnType >; export type Manifest = ManifestOf>; diff --git a/openai/loaders/vision.ts b/openai/loaders/vision.ts new file mode 100644 index 000000000..7d5a43932 --- /dev/null +++ b/openai/loaders/vision.ts @@ -0,0 +1,46 @@ +import { AppContext } from "../mod.ts"; +import { OpenAI } from "../deps.ts"; + +export interface Props { + /** + * @description the links of the site that contains images + * @examples "https://www.instagram.com/marcoscandeia" + */ + images: string[]; + /** + * @description what kind of description do you want? + * @examples you can ask for something like "What’s in this image?"\n or "Is there a car?" + */ + prompt: string; + choices?: number; + maxTokens?: number; +} + +export type Return = OpenAI.ChatCompletion; + +export default async function ( + { images, prompt, choices = 1, maxTokens = 4096 }: Props, + _req: Request, + ctx: AppContext, +): Promise { + const response = await ctx.openAI.chat.completions.create({ + n: choices, + stream: false, + max_tokens: maxTokens, + model: "gpt-4-vision-preview", + messages: [ + { + role: "user", + content: [ + { type: "text", text: prompt }, + ...images.map((image) => ({ + type: "image_url" as const, + image_url: { "url": image }, + })), + ], + }, + ], + }); + + return response; +} diff --git a/openai/manifest.gen.ts b/openai/manifest.gen.ts index 416aa7ef1..2b690a6c2 100644 --- a/openai/manifest.gen.ts +++ b/openai/manifest.gen.ts @@ -2,7 +2,12 @@ // This file SHOULD be checked into source version control. // This file is automatically updated during development when running `dev.ts`. +import * as $$$0 from "./loaders/vision.ts"; + const manifest = { + "loaders": { + "openai/loaders/vision.ts": $$$0, + }, "name": "openai", "baseUrl": import.meta.url, }; diff --git a/vtex/utils/openapi/vcs.openapi.gen.ts b/vtex/utils/openapi/vcs.openapi.gen.ts index 8f8473139..6a222674f 100644 --- a/vtex/utils/openapi/vcs.openapi.gen.ts +++ b/vtex/utils/openapi/vcs.openapi.gen.ts @@ -66,9 +66,9 @@ export type OptinNewsLetter = boolean export interface OpenAPI { /** - * Retrieves the IDs of products and SKUs. - * > 📘 Onboarding guide - * > + * Retrieves the IDs of products and SKUs. + * > 📘 Onboarding guide + * > * > Check the new [Catalog onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. */ "GET /api/catalog_system/pvt/products/GetProductAndSkuIds": { @@ -116,9 +116,9 @@ to?: number } } /** - * Retrieves a specific Product by its ID. This information is exactly what is needed to create a new Product. - * > 📘 Onboarding guide - * > + * Retrieves a specific Product by its ID. This information is exactly what is needed to create a new Product. + * > 📘 Onboarding guide + * > * > Check the new [Catalog onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. */ "GET /api/catalog/pvt/product/:productId": { @@ -160,9 +160,9 @@ IsVisible?: boolean */ Description?: string /** - * Short product description. This information can be displayed on both the product page and the shelf, using the following controls: - * Store Framework: `$product.DescriptionShort`. - * Legacy CMS Portal: ``. + * Short product description. This information can be displayed on both the product page and the shelf, using the following controls: + * Store Framework: `$product.DescriptionShort`. + * Legacy CMS Portal: ``. * */ DescriptionShort?: string @@ -171,8 +171,8 @@ DescriptionShort?: string */ ReleaseDate?: string /** - * Store Framework: Deprecated. - * Legacy CMS Portal: Keywords or synonyms related to the product, separated by comma (`,`). "Television", for example, can have a substitute word like "TV". This field is important to make your searches more comprehensive. + * Store Framework: Deprecated. + * Legacy CMS Portal: Keywords or synonyms related to the product, separated by comma (`,`). "Television", for example, can have a substitute word like "TV". This field is important to make your searches more comprehensive. * */ KeyWords?: string @@ -254,9 +254,9 @@ IsVisible?: boolean */ Description?: string /** - * Short product description. This information can be displayed on both the product page and the shelf, using the following controls: - * Store Framework: `$product.DescriptionShort`. - * Legacy CMS Portal: ``. + * Short product description. This information can be displayed on both the product page and the shelf, using the following controls: + * Store Framework: `$product.DescriptionShort`. + * Legacy CMS Portal: ``. * */ DescriptionShort?: string @@ -265,8 +265,8 @@ DescriptionShort?: string */ ReleaseDate?: string /** - * Store Framework: Deprecated. - * Legacy CMS Portal: Keywords or synonyms related to the product, separated by comma (`,`). "Television", for example, can have a substitute word like "TV". This field is important to make your searches more comprehensive. + * Store Framework: Deprecated. + * Legacy CMS Portal: Keywords or synonyms related to the product, separated by comma (`,`). "Television", for example, can have a substitute word like "TV". This field is important to make your searches more comprehensive. * */ KeyWords?: string @@ -347,9 +347,9 @@ IsVisible?: boolean */ Description?: string /** - * Short product description. This information can be displayed on both the product page and the shelf, using the following controls: - * Store Framework: `$product.DescriptionShort`. - * Legacy CMS Portal: ``. + * Short product description. This information can be displayed on both the product page and the shelf, using the following controls: + * Store Framework: `$product.DescriptionShort`. + * Legacy CMS Portal: ``. * */ DescriptionShort?: string @@ -358,8 +358,8 @@ DescriptionShort?: string */ ReleaseDate?: string /** - * Store Framework: Deprecated. - * Legacy CMS Portal: Keywords or synonyms related to the product, separated by comma (`,`). "Television", for example, can have a substitute word like "TV". This field is important to make your searches more comprehensive. + * Store Framework: Deprecated. + * Legacy CMS Portal: Keywords or synonyms related to the product, separated by comma (`,`). "Television", for example, can have a substitute word like "TV". This field is important to make your searches more comprehensive. * */ KeyWords?: string @@ -590,119 +590,119 @@ LomadeeCampaignCode?: string } } /** - * Retrieves data about the product and all SKUs related to it by the product's ID. - * ## Response body example - * - * ```json - * { - * "productId": 9, - * "name": "Camisa Masculina", - * "salesChannel": "2", - * "available": true, - * "displayMode": "lista", - * "dimensions": [ - * "Cores", - * "Tamanho", - * "País de origem", - * "Gênero" - * ], - * "dimensionsInputType": { - * "Cores": "Combo", - * "Tamanho": "Combo", - * "País de origem": "Combo", - * "Gênero": "Combo" - * }, - * "dimensionsMap": { - * "Cores": [ - * "Amarelo", - * "Azul", - * "Vermelho" - * ], - * "Tamanho": [ - * "P", - * "M", - * "G" - * ], - * "País de origem": [ - * "Brasil" - * ], - * "Gênero": [ - * "Masculino" - * ] - * }, - * "skus": [ - * { - * "sku": 310118454, - * "skuname": "Amarela - G", - * "dimensions": { - * "Cores": "Amarelo", - * "Tamanho": "G", - * "País de origem": "Brasil", - * "Gênero": "Masculino" - * }, - * "available": false, - * "availablequantity": 0, - * "cacheVersionUsedToCallCheckout": null, - * "listPriceFormated": "R$ 0,00", - * "listPrice": 0, - * "taxFormated": "R$ 0,00", - * "taxAsInt": 0, - * "bestPriceFormated": "R$ 9.999.876,00", - * "bestPrice": 999987600, - * "spotPrice": 999987600, - * "installments": 0, - * "installmentsValue": 0, - * "installmentsInsterestRate": null, - * "image": "https://lojadobreno.vteximg.com.br/arquivos/ids/155467-292-292/image-5d7ad76ad1954c53adecab4138319034.jpg?v=637321899584500000", - * "sellerId": "1", - * "seller": "lojadobreno", - * "measures": { - * "cubicweight": 1.0000, - * "height": 5.0000, - * "length": 20.0000, - * "weight": 200.0000, - * "width": 20.0000 - * }, - * "unitMultiplier": 1.0000, - * "rewardValue": 0 - * }, - * { - * "sku": 310118455, - * "skuname": "Vermelha - M", - * "dimensions": { - * "Cores": "Vermelho", - * "Tamanho": "M", - * "País de origem": "Brasil", - * "Gênero": "Masculino" - * }, - * "available": true, - * "availablequantity": 99999, - * "cacheVersionUsedToCallCheckout": "38395F1AEF59DF5CEAEDE472328145CD_", - * "listPriceFormated": "R$ 0,00", - * "listPrice": 0, - * "taxFormated": "R$ 0,00", - * "taxAsInt": 0, - * "bestPriceFormated": "R$ 20,00", - * "bestPrice": 2000, - * "spotPrice": 2000, - * "installments": 1, - * "installmentsValue": 2000, - * "installmentsInsterestRate": 0, - * "image": "https://lojadobreno.vteximg.com.br/arquivos/ids/155468-292-292/image-601a6099aace48b89d26fc9f22e8e611.jpg?v=637321906602470000", - * "sellerId": "pedrostore", - * "seller": "pedrostore", - * "measures": { - * "cubicweight": 0.4167, - * "height": 5.0000, - * "length": 20.0000, - * "weight": 200.0000, - * "width": 20.0000 - * }, - * "unitMultiplier": 1.0000, - * "rewardValue": 0 - * } - * ] - * } + * Retrieves data about the product and all SKUs related to it by the product's ID. + * ## Response body example + * + * ```json + * { + * "productId": 9, + * "name": "Camisa Masculina", + * "salesChannel": "2", + * "available": true, + * "displayMode": "lista", + * "dimensions": [ + * "Cores", + * "Tamanho", + * "País de origem", + * "Gênero" + * ], + * "dimensionsInputType": { + * "Cores": "Combo", + * "Tamanho": "Combo", + * "País de origem": "Combo", + * "Gênero": "Combo" + * }, + * "dimensionsMap": { + * "Cores": [ + * "Amarelo", + * "Azul", + * "Vermelho" + * ], + * "Tamanho": [ + * "P", + * "M", + * "G" + * ], + * "País de origem": [ + * "Brasil" + * ], + * "Gênero": [ + * "Masculino" + * ] + * }, + * "skus": [ + * { + * "sku": 310118454, + * "skuname": "Amarela - G", + * "dimensions": { + * "Cores": "Amarelo", + * "Tamanho": "G", + * "País de origem": "Brasil", + * "Gênero": "Masculino" + * }, + * "available": false, + * "availablequantity": 0, + * "cacheVersionUsedToCallCheckout": null, + * "listPriceFormated": "R$ 0,00", + * "listPrice": 0, + * "taxFormated": "R$ 0,00", + * "taxAsInt": 0, + * "bestPriceFormated": "R$ 9.999.876,00", + * "bestPrice": 999987600, + * "spotPrice": 999987600, + * "installments": 0, + * "installmentsValue": 0, + * "installmentsInsterestRate": null, + * "image": "https://lojadobreno.vteximg.com.br/arquivos/ids/155467-292-292/image-5d7ad76ad1954c53adecab4138319034.jpg?v=637321899584500000", + * "sellerId": "1", + * "seller": "lojadobreno", + * "measures": { + * "cubicweight": 1.0000, + * "height": 5.0000, + * "length": 20.0000, + * "weight": 200.0000, + * "width": 20.0000 + * }, + * "unitMultiplier": 1.0000, + * "rewardValue": 0 + * }, + * { + * "sku": 310118455, + * "skuname": "Vermelha - M", + * "dimensions": { + * "Cores": "Vermelho", + * "Tamanho": "M", + * "País de origem": "Brasil", + * "Gênero": "Masculino" + * }, + * "available": true, + * "availablequantity": 99999, + * "cacheVersionUsedToCallCheckout": "38395F1AEF59DF5CEAEDE472328145CD_", + * "listPriceFormated": "R$ 0,00", + * "listPrice": 0, + * "taxFormated": "R$ 0,00", + * "taxAsInt": 0, + * "bestPriceFormated": "R$ 20,00", + * "bestPrice": 2000, + * "spotPrice": 2000, + * "installments": 1, + * "installmentsValue": 2000, + * "installmentsInsterestRate": 0, + * "image": "https://lojadobreno.vteximg.com.br/arquivos/ids/155468-292-292/image-601a6099aace48b89d26fc9f22e8e611.jpg?v=637321906602470000", + * "sellerId": "pedrostore", + * "seller": "pedrostore", + * "measures": { + * "cubicweight": 0.4167, + * "height": 5.0000, + * "length": 20.0000, + * "weight": 200.0000, + * "width": 20.0000 + * }, + * "unitMultiplier": 1.0000, + * "rewardValue": 0 + * } + * ] + * } * ``` */ "GET /api/catalog_system/pub/products/variations/:productId": { @@ -870,98 +870,98 @@ rewardValue?: number response: number } /** - * This endpoint allows two types of request: - * - * **Type 1:** Creating a new Product as well as a new Category path (including subcategories) and a new Brand by using `CategoryPath` and `BrandName` parameters. - * - * **Type 2:** Creating a new Product given an existing `BrandId` and an existing `CategoryId`. - * - * When creating a product, regardless of the type of request, if there is a need to create a new product with a specific custom product ID, specify the `Id` (integer) in the request body. Otherwise, VTEX will generate the ID automatically. - * - * ## Request body examples - * - * ### Type 1 - * - * Request to create a product, associating it to a new Category and a new Brand by using `CategoryPath` and `BrandName`: - * - * ```json - * { - * "Name": "Black T-Shirt", - * "CategoryPath": "Mens/Clothing/T-Shirts", - * "BrandName": "Nike", - * "RefId": "31011706925", - * "Title": "Black T-Shirt", - * "LinkId": "tshirt-black", - * "Description": "This is a cool Tshirt", - * "ReleaseDate": "2022-01-01T00:00:00", - * "IsVisible": true, - * "IsActive": true, - * "TaxCode": "", - * "MetaTagDescription": "tshirt black", - * "ShowWithoutStock": true, - * "Score": 1 - * } - * ``` - * - * ### Type 2 - * - * Request to create a product, associating it to an existing `CategoryId` and `BrandId`: - * - * ```json - * { - * "Name": "insert product test", - * "DepartmentId": 1, - * "CategoryId": 2, - * "BrandId": 2000000, - * "LinkId": "insert-product-test", - * "RefId": "310117869", - * "IsVisible": true, - * "Description": "texto de descrição", - * "DescriptionShort": "Utilize o CEP 04548-005 para frete grátis", - * "ReleaseDate": "2019-01-01T00:00:00", - * "KeyWords": "teste,teste2", - * "Title": "product de teste", - * "IsActive": true, - * "TaxCode": "", - * "MetaTagDescription": "tag test", - * "SupplierId": 1, - * "ShowWithoutStock": true, - * "AdWordsRemarketingCode": null, - * "LomadeeCampaignCode": null, - * "Score": 1 - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 52, - * "Name": "insert product test", - * "DepartmentId": 1, - * "CategoryId": 2, - * "BrandId": 2000000, - * "LinkId": "insert-product-test", - * "RefId": "310117869", - * "IsVisible": true, - * "Description": "texto de descrição", - * "DescriptionShort": "Utilize o CEP 04548-005 para frete grátis", - * "ReleaseDate": "2019-01-01T00:00:00", - * "KeyWords": "teste,teste2", - * "Title": "product de teste", - * "IsActive": true, - * "TaxCode": "", - * "MetaTagDescription": "tag test", - * "SupplierId": 1, - * "ShowWithoutStock": true, - * "AdWordsRemarketingCode": null, - * "LomadeeCampaignCode": null, - * "Score": 1 - * } - * ``` - * - * > 📘 Onboarding guide - * > + * This endpoint allows two types of request: + * + * **Type 1:** Creating a new Product as well as a new Category path (including subcategories) and a new Brand by using `CategoryPath` and `BrandName` parameters. + * + * **Type 2:** Creating a new Product given an existing `BrandId` and an existing `CategoryId`. + * + * When creating a product, regardless of the type of request, if there is a need to create a new product with a specific custom product ID, specify the `Id` (integer) in the request body. Otherwise, VTEX will generate the ID automatically. + * + * ## Request body examples + * + * ### Type 1 + * + * Request to create a product, associating it to a new Category and a new Brand by using `CategoryPath` and `BrandName`: + * + * ```json + * { + * "Name": "Black T-Shirt", + * "CategoryPath": "Mens/Clothing/T-Shirts", + * "BrandName": "Nike", + * "RefId": "31011706925", + * "Title": "Black T-Shirt", + * "LinkId": "tshirt-black", + * "Description": "This is a cool Tshirt", + * "ReleaseDate": "2022-01-01T00:00:00", + * "IsVisible": true, + * "IsActive": true, + * "TaxCode": "", + * "MetaTagDescription": "tshirt black", + * "ShowWithoutStock": true, + * "Score": 1 + * } + * ``` + * + * ### Type 2 + * + * Request to create a product, associating it to an existing `CategoryId` and `BrandId`: + * + * ```json + * { + * "Name": "insert product test", + * "DepartmentId": 1, + * "CategoryId": 2, + * "BrandId": 2000000, + * "LinkId": "insert-product-test", + * "RefId": "310117869", + * "IsVisible": true, + * "Description": "texto de descrição", + * "DescriptionShort": "Utilize o CEP 04548-005 para frete grátis", + * "ReleaseDate": "2019-01-01T00:00:00", + * "KeyWords": "teste,teste2", + * "Title": "product de teste", + * "IsActive": true, + * "TaxCode": "", + * "MetaTagDescription": "tag test", + * "SupplierId": 1, + * "ShowWithoutStock": true, + * "AdWordsRemarketingCode": null, + * "LomadeeCampaignCode": null, + * "Score": 1 + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 52, + * "Name": "insert product test", + * "DepartmentId": 1, + * "CategoryId": 2, + * "BrandId": 2000000, + * "LinkId": "insert-product-test", + * "RefId": "310117869", + * "IsVisible": true, + * "Description": "texto de descrição", + * "DescriptionShort": "Utilize o CEP 04548-005 para frete grátis", + * "ReleaseDate": "2019-01-01T00:00:00", + * "KeyWords": "teste,teste2", + * "Title": "product de teste", + * "IsActive": true, + * "TaxCode": "", + * "MetaTagDescription": "tag test", + * "SupplierId": 1, + * "ShowWithoutStock": true, + * "AdWordsRemarketingCode": null, + * "LomadeeCampaignCode": null, + * "Score": 1 + * } + * ``` + * + * > 📘 Onboarding guide + * > * > Check the new [Catalog onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. */ "POST /api/catalog/pvt/product": { @@ -1007,9 +1007,9 @@ IsVisible?: boolean */ Description?: string /** - * Short product description. This information can be displayed on both the product page and the shelf, using the following controls: - * Store Framework: `$product.DescriptionShort`. - * Legacy CMS Portal: ``. + * Short product description. This information can be displayed on both the product page and the shelf, using the following controls: + * Store Framework: `$product.DescriptionShort`. + * Legacy CMS Portal: ``. * */ DescriptionShort?: string @@ -1018,8 +1018,8 @@ DescriptionShort?: string */ ReleaseDate?: string /** - * Store Framework: Deprecated. - * Legacy CMS Portal: Keywords or synonyms related to the product, separated by comma (`,`). "Television", for example, can have a substitute word like "TV". This field is important to make your searches more comprehensive. + * Store Framework: Deprecated. + * Legacy CMS Portal: Keywords or synonyms related to the product, separated by comma (`,`). "Television", for example, can have a substitute word like "TV". This field is important to make your searches more comprehensive. * */ KeyWords?: string @@ -1100,9 +1100,9 @@ IsVisible?: boolean */ Description?: string /** - * Short product description. This information can be displayed on both the product page and the shelf, using the following controls: - * Store Framework: `$product.DescriptionShort`. - * Legacy CMS Portal: ``. + * Short product description. This information can be displayed on both the product page and the shelf, using the following controls: + * Store Framework: `$product.DescriptionShort`. + * Legacy CMS Portal: ``. * */ DescriptionShort?: string @@ -1111,8 +1111,8 @@ DescriptionShort?: string */ ReleaseDate?: string /** - * Store Framework: Deprecated. - * Legacy CMS Portal: Keywords or synonyms related to the product, separated by comma (`,`). "Television", for example, can have a substitute word like "TV". This field is important to make your searches more comprehensive. + * Store Framework: Deprecated. + * Legacy CMS Portal: Keywords or synonyms related to the product, separated by comma (`,`). "Television", for example, can have a substitute word like "TV". This field is important to make your searches more comprehensive. * */ KeyWords?: string @@ -1157,72 +1157,72 @@ Score?: number } } /** - * Retrieves all specifications of a product by the product's ID. - * > 📘 Onboarding guide - * > - * > Check the new [Catalog onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. - * - * ### Response body example - * - * ```json - * [ - * { - * "Value": [ - * "Iron", - * "Plastic" - * ], - * "Id": 30, - * "Name": "Material" - * } - * ] + * Retrieves all specifications of a product by the product's ID. + * > 📘 Onboarding guide + * > + * > Check the new [Catalog onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. + * + * ### Response body example + * + * ```json + * [ + * { + * "Value": [ + * "Iron", + * "Plastic" + * ], + * "Id": 30, + * "Name": "Material" + * } + * ] * ``` */ "GET /api/catalog_system/pvt/products/:productId/specification": { response: GetorUpdateProductSpecification[] } /** - * 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. - * - * ### Request body example - * - * ```json - * [ - * { - * "Value": [ - * "Iron", - * "Plastic" - * ], - * "Id": 30, - * "Name": "Material" - * } - * ] + * 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. + * + * ### Request body example + * + * ```json + * [ + * { + * "Value": [ + * "Iron", + * "Plastic" + * ], + * "Id": 30, + * "Name": "Material" + * } + * ] * ``` */ "POST /api/catalog_system/pvt/products/:productId/specification": { body: GetorUpdateProductSpecification[] } /** - * Retrieves information of all specifications of a product by the product's ID. - * - * ### Response body example - * - * ```json - * [ - * { - * "Id": 227, - * "ProductId": 1, - * "FieldId": 33, - * "FieldValueId": 135, - * "Text": "ValueA" - * }, - * { - * "Id": 228, - * "ProductId": 1, - * "FieldId": 34, - * "FieldValueId": 1, - * "Text": "Giant" - * } - * ] + * Retrieves information of all specifications of a product by the product's ID. + * + * ### Response body example + * + * ```json + * [ + * { + * "Id": 227, + * "ProductId": 1, + * "FieldId": 33, + * "FieldValueId": 135, + * "Text": "ValueA" + * }, + * { + * "Id": 228, + * "ProductId": 1, + * "FieldId": 34, + * "FieldValueId": 1, + * "Text": "Giant" + * } + * ] * ``` */ "GET /api/catalog/pvt/product/:productId/specification": { @@ -1250,27 +1250,27 @@ Text?: string }[] } /** - * Associates a previously defined Specification to a Product. - * - * ### Request body example - * - * ```json - * { - * "FieldId": 19, - * "FieldValueId": 1, - * "Text": "test" - * } - * ``` - * - * ### Response body example - * - * ```json - * { - * "Id": 41, - * "FieldId": 19, - * "FieldValueId": 1, - * "Text": "test" - * } + * Associates a previously defined Specification to a Product. + * + * ### Request body example + * + * ```json + * { + * "FieldId": 19, + * "FieldValueId": 1, + * "Text": "test" + * } + * ``` + * + * ### Response body example + * + * ```json + * { + * "Id": 41, + * "FieldId": 19, + * "FieldValueId": 1, + * "Text": "test" + * } * ``` */ "POST /api/catalog/pvt/product/:productId/specification": { @@ -1324,43 +1324,43 @@ Text?: string } /** - * Associates a specification to a product using specification name and group name. Automatically creates the informed group, specification and values if they had not been created before. - * - * ## Request body example - * - * ```json - * { - * "FieldName": "Material", - * "GroupName": "Additional Information", - * "RootLevelSpecification": false, - * "FieldValues": [ - * "Cotton", - * "Polyester" - * ] - * } - * ``` - * - * - * ## Response body example - * - * ```json - * [ - * { - * "Id": 53, - * "ProductId": 3, - * "FieldId": 21, - * "FieldValueId": 60, - * "Text": "Cotton" - * }, - * { - * "Id": 54, - * "ProductId": 3, - * "FieldId": 21, - * "FieldValueId": 61, - * "Text": "Polyester" - * } - * ] - * ``` + * Associates a specification to a product using specification name and group name. Automatically creates the informed group, specification and values if they had not been created before. + * + * ## Request body example + * + * ```json + * { + * "FieldName": "Material", + * "GroupName": "Additional Information", + * "RootLevelSpecification": false, + * "FieldValues": [ + * "Cotton", + * "Polyester" + * ] + * } + * ``` + * + * + * ## Response body example + * + * ```json + * [ + * { + * "Id": 53, + * "ProductId": 3, + * "FieldId": 21, + * "FieldValueId": 60, + * "Text": "Cotton" + * }, + * { + * "Id": 54, + * "ProductId": 3, + * "FieldId": 21, + * "FieldValueId": 61, + * "Text": "Polyester" + * } + * ] + * ``` * */ "PUT /api/catalog/pvt/product/:productId/specificationvalue": { @@ -1409,26 +1409,26 @@ Text?: string }[] } /** - * Retrieves the IDs of all SKUs in your store. Presents the results with page size and pagination. - * > 📘 Onboarding guide - * > - * > Check the new [Catalog onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. - * - * ### Response body example - * - * ```json - * [ - * 1, - * 2, - * 3, - * 4, - * 5, - * 6, - * 7, - * 8, - * 9, - * 10 - * ] + * Retrieves the IDs of all SKUs in your store. Presents the results with page size and pagination. + * > 📘 Onboarding guide + * > + * > Check the new [Catalog onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. + * + * ### Response body example + * + * ```json + * [ + * 1, + * 2, + * 3, + * 4, + * 5, + * 6, + * 7, + * 8, + * 9, + * 10 + * ] * ``` */ "GET /api/catalog_system/pvt/sku/stockkeepingunitids": { @@ -1448,209 +1448,209 @@ pagesize: number response: number[] } /** - * Retrieves context of an SKU. - * > 📘 Onboarding guide - * > - * > Check the new [Catalog onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. - * - * ## Response body example - * - * ```json - * { - * "Id": 2001773, - * "ProductId": 2001426, - * "NameComplete": "Tabela de Basquete", - * "ComplementName": "", - * "ProductName": "Tabela de Basquete", - * "ProductDescription": "Tabela de Basquete", - * "SkuName": "Tabela de Basquete", - * "ProductRefId": "0987", - * "TaxCode": "", - * "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", - * "IsBrandActive": true, - * "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": [], - * "CategoriesFullPath": [ - * "/1/10/", - * "/1/", - * "/20/" - * ], - * "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 - * } - * ], - * "Videos": [ - * "www.google.com" - * ], - * "SkuSpecifications": [ - * { - * "FieldId": 102, - * "FieldName": "Cor", - * "FieldValueIds": [ - * 266 - * ], - * "FieldValues": [ - * "Padrão" - * ], - * "IsFilter": false, - * "FieldGroupId": 11, - * "FieldGroupName": "Especificações" - * } - * ], - * "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" - * ], - * "IsFilter": true, - * "FieldGroupId": 17, - * "FieldGroupName": "NewGroupName 2" - * }, - * { - * "FieldId": 23, - * "FieldName": "Fabricante", - * "FieldValueIds": [], - * "FieldValues": [ - * "Xalingo" - * ], - * "IsFilter": false, - * "FieldGroupId": 17, - * "FieldGroupName": "NewGroupName 2" - * } - * ], - * "ProductClustersIds": "176,187,192,194,211,217,235,242", - * "PositionsInClusters": { - * "151": 3, - * "152": 0, - * "158": 1 - * }, - * "ProductClusterNames": { - * "151": "asdfghj", - * "152": "George", - * "158": "Coleção halloween" - * }, - * "ProductClusterHighlights": { - * "151": "asdfghj", - * "152": "George" - * }, - * "ProductCategoryIds": "/59/", - * "IsDirectCategoryActive": false, - * "ProductGlobalCategoryId": null, - * "ProductCategories": { - * "59": "Brinquedos" - * }, - * "CommercialConditionId": 1, - * "RewardValue": 100.0, - * "AlternateIds": { - * "Ean": "8781", - * "RefId": "878181" - * }, - * "AlternateIdValues": [ - * "8781", - * "878181" - * ], - * "EstimatedDateArrival": "", - * "MeasurementUnit": "un", - * "UnitMultiplier": 2.0000, - * "InformationSource": "Indexer", - * "ModalType": "", - * "KeyWords": "basquete, tabela", - * "ReleaseDate": "2020-01-06T00:00:00", - * "ProductIsVisible": true, - * "ShowIfNotAvailable": true, - * "IsProductActive": true, - * "ProductFinalScore": 0 - * } + * Retrieves context of an SKU. + * > 📘 Onboarding guide + * > + * > Check the new [Catalog onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. + * + * ## Response body example + * + * ```json + * { + * "Id": 2001773, + * "ProductId": 2001426, + * "NameComplete": "Tabela de Basquete", + * "ComplementName": "", + * "ProductName": "Tabela de Basquete", + * "ProductDescription": "Tabela de Basquete", + * "SkuName": "Tabela de Basquete", + * "ProductRefId": "0987", + * "TaxCode": "", + * "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", + * "IsBrandActive": true, + * "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": [], + * "CategoriesFullPath": [ + * "/1/10/", + * "/1/", + * "/20/" + * ], + * "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 + * } + * ], + * "Videos": [ + * "www.google.com" + * ], + * "SkuSpecifications": [ + * { + * "FieldId": 102, + * "FieldName": "Cor", + * "FieldValueIds": [ + * 266 + * ], + * "FieldValues": [ + * "Padrão" + * ], + * "IsFilter": false, + * "FieldGroupId": 11, + * "FieldGroupName": "Especificações" + * } + * ], + * "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" + * ], + * "IsFilter": true, + * "FieldGroupId": 17, + * "FieldGroupName": "NewGroupName 2" + * }, + * { + * "FieldId": 23, + * "FieldName": "Fabricante", + * "FieldValueIds": [], + * "FieldValues": [ + * "Xalingo" + * ], + * "IsFilter": false, + * "FieldGroupId": 17, + * "FieldGroupName": "NewGroupName 2" + * } + * ], + * "ProductClustersIds": "176,187,192,194,211,217,235,242", + * "PositionsInClusters": { + * "151": 3, + * "152": 0, + * "158": 1 + * }, + * "ProductClusterNames": { + * "151": "asdfghj", + * "152": "George", + * "158": "Coleção halloween" + * }, + * "ProductClusterHighlights": { + * "151": "asdfghj", + * "152": "George" + * }, + * "ProductCategoryIds": "/59/", + * "IsDirectCategoryActive": false, + * "ProductGlobalCategoryId": null, + * "ProductCategories": { + * "59": "Brinquedos" + * }, + * "CommercialConditionId": 1, + * "RewardValue": 100.0, + * "AlternateIds": { + * "Ean": "8781", + * "RefId": "878181" + * }, + * "AlternateIdValues": [ + * "8781", + * "878181" + * ], + * "EstimatedDateArrival": "", + * "MeasurementUnit": "un", + * "UnitMultiplier": 2.0000, + * "InformationSource": "Indexer", + * "ModalType": "", + * "KeyWords": "basquete, tabela", + * "ReleaseDate": "2020-01-06T00:00:00", + * "ProductIsVisible": true, + * "ShowIfNotAvailable": true, + * "IsProductActive": true, + * "ProductFinalScore": 0 + * } * ``` */ "GET /api/catalog_system/pvt/sku/stockkeepingunitbyid/:skuId": { @@ -1663,38 +1663,38 @@ sc?: number response: GetSKUandContext } /** - * Retrieves information about a specific SKU by its `RefId`. - * - * ### Response body example - * - * ```json - * { - * "Id": 1, - * "ProductId": 1, - * "IsActive": true, - * "Name": "Royal Canin Feline Urinary 500g", - * "RefId": "0001", - * "PackagedHeight": 6.0000, - * "PackagedLength": 24.0000, - * "PackagedWidth": 14.0000, - * "PackagedWeightKg": 550.0000, - * "Height": null, - * "Length": null, - * "Width": null, - * "WeightKg": null, - * "CubicWeight": 1.0000, - * "IsKit": false, - * "CreationDate": "2020-03-12T15:42:00", - * "RewardValue": null, - * "EstimatedDateArrival": null, - * "ManufacturerCode": "", - * "CommercialConditionId": 1, - * "MeasurementUnit": "un", - * "UnitMultiplier": 1.0000, - * "ModalType": null, - * "KitItensSellApart": false, - * "Videos": null - * } + * Retrieves information about a specific SKU by its `RefId`. + * + * ### Response body example + * + * ```json + * { + * "Id": 1, + * "ProductId": 1, + * "IsActive": true, + * "Name": "Royal Canin Feline Urinary 500g", + * "RefId": "0001", + * "PackagedHeight": 6.0000, + * "PackagedLength": 24.0000, + * "PackagedWidth": 14.0000, + * "PackagedWeightKg": 550.0000, + * "Height": null, + * "Length": null, + * "Width": null, + * "WeightKg": null, + * "CubicWeight": 1.0000, + * "IsKit": false, + * "CreationDate": "2020-03-12T15:42:00", + * "RewardValue": null, + * "EstimatedDateArrival": null, + * "ManufacturerCode": "", + * "CommercialConditionId": 1, + * "MeasurementUnit": "un", + * "UnitMultiplier": 1.0000, + * "ModalType": null, + * "KitItensSellApart": false, + * "Videos": null + * } * ``` */ "GET /api/catalog/pvt/stockkeepingunit": { @@ -1812,111 +1812,111 @@ Videos?: (null | string) } } /** - * - * - * Creates a new SKU. - * - * If there is a need to create a new SKU with a specific custom ID, specify the `Id` (integer) in the request. Otherwise, VTEX will generate the ID automatically. - * - * ### Request body example (custom ID) - * - * ```json - * { - * "Id": 1, - * "ProductId": 310117069, - * "IsActive": false, - * "ActivateIfPossible": true, - * "Name": "sku test", - * "RefId": "125478", - * "Ean": "8949461894984", - * "PackagedHeight": 10, - * "PackagedLength": 10, - * "PackagedWidth": 10, - * "PackagedWeightKg": 10, - * "Height": null, - * "Length": null, - * "Width": null, - * "WeightKg": null, - * "CubicWeight": 0.1667, - * "IsKit": false, - * "CreationDate": null, - * "RewardValue": null, - * "EstimatedDateArrival": null, - * "ManufacturerCode": "123", - * "CommercialConditionId": 1, - * "MeasurementUnit": "un", - * "UnitMultiplier": 2.0000, - * "ModalType": null, - * "KitItensSellApart": false, - * "Videos": [ "https://www.youtube.com/" ] - * } - * ``` - * - * ### Request body example (automatically generated ID) - * - * ```json - * { - * "ProductId": 310117069, - * "IsActive": false, - * "ActivateIfPossible": true, - * "Name": "sku test", - * "RefId": "125478", - * "Ean": "8949461894984", - * "PackagedHeight": 10, - * "PackagedLength": 10, - * "PackagedWidth": 10, - * "PackagedWeightKg": 10, - * "Height": null, - * "Length": null, - * "Width": null, - * "WeightKg": null, - * "CubicWeight": 0.1667, - * "IsKit": false, - * "CreationDate": null, - * "RewardValue": null, - * "EstimatedDateArrival": null, - * "ManufacturerCode": "123", - * "CommercialConditionId": 1, - * "MeasurementUnit": "un", - * "UnitMultiplier": 2.0000, - * "ModalType": null, - * "KitItensSellApart": false, - * "Videos": [ "https://www.youtube.com/" ] - * } - * ``` - * - * ### Response body example - * - * ```json - * { - * "Id":1, - * "ProductId": 310117069, - * "IsActive": false, - * "ActivateIfPossible": true, - * "Name": "sku test", - * "RefId": "125478", - * "Ean": "8949461894984", - * "PackagedHeight": 10, - * "PackagedLength": 10, - * "PackagedWidth": 10, - * "PackagedWeightKg": 10, - * "Height": null, - * "Length": null, - * "Width": null, - * "WeightKg": null, - * "CubicWeight": 0.1667, - * "IsKit": false, - * "CreationDate": null, - * "RewardValue": null, - * "EstimatedDateArrival": null, - * "ManufacturerCode": "123", - * "CommercialConditionId": 1, - * "MeasurementUnit": "un", - * "UnitMultiplier": 2.0000, - * "ModalType": null, - * "KitItensSellApart": false, - * "Videos": [ "https://www.youtube.com/" ] - * } + * + * + * Creates a new SKU. + * + * If there is a need to create a new SKU with a specific custom ID, specify the `Id` (integer) in the request. Otherwise, VTEX will generate the ID automatically. + * + * ### Request body example (custom ID) + * + * ```json + * { + * "Id": 1, + * "ProductId": 310117069, + * "IsActive": false, + * "ActivateIfPossible": true, + * "Name": "sku test", + * "RefId": "125478", + * "Ean": "8949461894984", + * "PackagedHeight": 10, + * "PackagedLength": 10, + * "PackagedWidth": 10, + * "PackagedWeightKg": 10, + * "Height": null, + * "Length": null, + * "Width": null, + * "WeightKg": null, + * "CubicWeight": 0.1667, + * "IsKit": false, + * "CreationDate": null, + * "RewardValue": null, + * "EstimatedDateArrival": null, + * "ManufacturerCode": "123", + * "CommercialConditionId": 1, + * "MeasurementUnit": "un", + * "UnitMultiplier": 2.0000, + * "ModalType": null, + * "KitItensSellApart": false, + * "Videos": [ "https://www.youtube.com/" ] + * } + * ``` + * + * ### Request body example (automatically generated ID) + * + * ```json + * { + * "ProductId": 310117069, + * "IsActive": false, + * "ActivateIfPossible": true, + * "Name": "sku test", + * "RefId": "125478", + * "Ean": "8949461894984", + * "PackagedHeight": 10, + * "PackagedLength": 10, + * "PackagedWidth": 10, + * "PackagedWeightKg": 10, + * "Height": null, + * "Length": null, + * "Width": null, + * "WeightKg": null, + * "CubicWeight": 0.1667, + * "IsKit": false, + * "CreationDate": null, + * "RewardValue": null, + * "EstimatedDateArrival": null, + * "ManufacturerCode": "123", + * "CommercialConditionId": 1, + * "MeasurementUnit": "un", + * "UnitMultiplier": 2.0000, + * "ModalType": null, + * "KitItensSellApart": false, + * "Videos": [ "https://www.youtube.com/" ] + * } + * ``` + * + * ### Response body example + * + * ```json + * { + * "Id":1, + * "ProductId": 310117069, + * "IsActive": false, + * "ActivateIfPossible": true, + * "Name": "sku test", + * "RefId": "125478", + * "Ean": "8949461894984", + * "PackagedHeight": 10, + * "PackagedLength": 10, + * "PackagedWidth": 10, + * "PackagedWeightKg": 10, + * "Height": null, + * "Length": null, + * "Width": null, + * "WeightKg": null, + * "CubicWeight": 0.1667, + * "IsKit": false, + * "CreationDate": null, + * "RewardValue": null, + * "EstimatedDateArrival": null, + * "ManufacturerCode": "123", + * "CommercialConditionId": 1, + * "MeasurementUnit": "un", + * "UnitMultiplier": 2.0000, + * "ModalType": null, + * "KitItensSellApart": false, + * "Videos": [ "https://www.youtube.com/" ] + * } * ``` */ "POST /api/catalog/pvt/stockkeepingunit": { @@ -2142,12 +2142,12 @@ Videos?: string[] } } /** - * Retrieves an SKU ID by the SKU's Reference ID. - * - * ### Response body example - * - * ```json - * "310118450" + * Retrieves an SKU ID by the SKU's Reference ID. + * + * ### Response body example + * + * ```json + * "310118450" * ``` */ "GET /api/catalog_system/pvt/sku/stockkeepingunitidbyrefid/:refId": { @@ -2157,205 +2157,205 @@ Videos?: string[] response: string } /** - * Retrieves an SKU by its Alternate ID. - * - * ### Response body example - * - * ```json - * { - * "Id": 310118450, - * "ProductId": 2, - * "NameComplete": "Caixa de Areia Azul Petmate sku test", - * "ComplementName": "", - * "ProductName": "Caixa de Areia Azul Petmate", - * "ProductDescription": "", - * "ProductRefId": "", - * "TaxCode": "", - * "SkuName": "sku test", - * "IsActive": true, - * "IsTransported": true, - * "IsInventoried": true, - * "IsGiftCardRecharge": false, - * "ImageUrl": "https://lojadobreno.vteximg.com.br/arquivos/ids/155451-55-55/caixa-areia-azul-petmate.jpg?v=637139451191670000", - * "DetailUrl": "/caixa-de-areia-azul-petmate/p", - * "CSCIdentification": null, - * "BrandId": "2000005", - * "BrandName": "Petmate", - * "IsBrandActive": true, - * "Dimension": { - * "cubicweight": 0.2083, - * "height": 10.0000, - * "length": 10.0000, - * "weight": 10.0000, - * "width": 10.0000 - * }, - * "RealDimension": { - * "realCubicWeight": 0.000, - * "realHeight": 0.0, - * "realLength": 0.0, - * "realWeight": 0.0, - * "realWidth": 0.0 - * }, - * "ManufacturerCode": "123", - * "IsKit": false, - * "KitItems": [], - * "Services": [], - * "Categories": [], - * "CategoriesFullPath": [ - * "/3/15/", - * "/3/", - * "/1/" - * ], - * "Attachments": [], - * "Collections": [], - * "SkuSellers": [ - * { - * "SellerId": "1", - * "StockKeepingUnitId": 310118450, - * "SellerStockKeepingUnitId": "310118450", - * "IsActive": true, - * "FreightCommissionPercentage": 0.0, - * "ProductCommissionPercentage": 0.0 - * } - * ], - * "SalesChannels": [ - * 1, - * 3 - * ], - * "Images": [ - * { - * "ImageUrl": "https://lojadobreno.vteximg.com.br/arquivos/ids/155451/caixa-areia-azul-petmate.jpg?v=637139451191670000", - * "ImageName": null, - * "FileId": 155451 - * } - * ], - * "Videos": [], - * "SkuSpecifications": [], - * "ProductSpecifications": [], - * "ProductClustersIds": "151,158", - * "PositionsInClusters": { - * "151": 1, - * "158": 2 - * }, - * "ProductClusterNames": { - * "151": "asdfghj", - * "158": "Coleção halloween" - * }, - * "ProductClusterHighlights": { - * "151": "asdfghj" - * }, - * "ProductCategoryIds": "/3/15/", - * "IsDirectCategoryActive": true, - * "ProductGlobalCategoryId": 5000, - * "ProductCategories": { - * "15": "Caixa de Areia", - * "3": "Higiene", - * "1": "Alimentação" - * }, - * "CommercialConditionId": 1, - * "RewardValue": 0.0, - * "AlternateIds": { - * "RefId": "1" - * }, - * "AlternateIdValues": [ - * "1" - * ], - * "EstimatedDateArrival": null, - * "MeasurementUnit": "un", - * "UnitMultiplier": 1.0000, - * "InformationSource": null, - * "ModalType": null, - * "KeyWords": "", - * "ReleaseDate": "2020-01-06T00:00:00Z", - * "ProductIsVisible": true, - * "ShowIfNotAvailable": true, - * "IsProductActive": true, - * "ProductFinalScore": 0 - * } + * Retrieves an SKU by its Alternate ID. + * + * ### Response body example + * + * ```json + * { + * "Id": 310118450, + * "ProductId": 2, + * "NameComplete": "Caixa de Areia Azul Petmate sku test", + * "ComplementName": "", + * "ProductName": "Caixa de Areia Azul Petmate", + * "ProductDescription": "", + * "ProductRefId": "", + * "TaxCode": "", + * "SkuName": "sku test", + * "IsActive": true, + * "IsTransported": true, + * "IsInventoried": true, + * "IsGiftCardRecharge": false, + * "ImageUrl": "https://lojadobreno.vteximg.com.br/arquivos/ids/155451-55-55/caixa-areia-azul-petmate.jpg?v=637139451191670000", + * "DetailUrl": "/caixa-de-areia-azul-petmate/p", + * "CSCIdentification": null, + * "BrandId": "2000005", + * "BrandName": "Petmate", + * "IsBrandActive": true, + * "Dimension": { + * "cubicweight": 0.2083, + * "height": 10.0000, + * "length": 10.0000, + * "weight": 10.0000, + * "width": 10.0000 + * }, + * "RealDimension": { + * "realCubicWeight": 0.000, + * "realHeight": 0.0, + * "realLength": 0.0, + * "realWeight": 0.0, + * "realWidth": 0.0 + * }, + * "ManufacturerCode": "123", + * "IsKit": false, + * "KitItems": [], + * "Services": [], + * "Categories": [], + * "CategoriesFullPath": [ + * "/3/15/", + * "/3/", + * "/1/" + * ], + * "Attachments": [], + * "Collections": [], + * "SkuSellers": [ + * { + * "SellerId": "1", + * "StockKeepingUnitId": 310118450, + * "SellerStockKeepingUnitId": "310118450", + * "IsActive": true, + * "FreightCommissionPercentage": 0.0, + * "ProductCommissionPercentage": 0.0 + * } + * ], + * "SalesChannels": [ + * 1, + * 3 + * ], + * "Images": [ + * { + * "ImageUrl": "https://lojadobreno.vteximg.com.br/arquivos/ids/155451/caixa-areia-azul-petmate.jpg?v=637139451191670000", + * "ImageName": null, + * "FileId": 155451 + * } + * ], + * "Videos": [], + * "SkuSpecifications": [], + * "ProductSpecifications": [], + * "ProductClustersIds": "151,158", + * "PositionsInClusters": { + * "151": 1, + * "158": 2 + * }, + * "ProductClusterNames": { + * "151": "asdfghj", + * "158": "Coleção halloween" + * }, + * "ProductClusterHighlights": { + * "151": "asdfghj" + * }, + * "ProductCategoryIds": "/3/15/", + * "IsDirectCategoryActive": true, + * "ProductGlobalCategoryId": 5000, + * "ProductCategories": { + * "15": "Caixa de Areia", + * "3": "Higiene", + * "1": "Alimentação" + * }, + * "CommercialConditionId": 1, + * "RewardValue": 0.0, + * "AlternateIds": { + * "RefId": "1" + * }, + * "AlternateIdValues": [ + * "1" + * ], + * "EstimatedDateArrival": null, + * "MeasurementUnit": "un", + * "UnitMultiplier": 1.0000, + * "InformationSource": null, + * "ModalType": null, + * "KeyWords": "", + * "ReleaseDate": "2020-01-06T00:00:00Z", + * "ProductIsVisible": true, + * "ShowIfNotAvailable": true, + * "IsProductActive": true, + * "ProductFinalScore": 0 + * } * ``` */ "GET /api/catalog_system/pvt/sku/stockkeepingunitbyalternateId/:alternateId": { response: GetSKUAltID } /** - * Retrieves a list with the SKUs related to a product by the product's ID. - * - * ### Response body example - * - * ```json - * [ - * { - * "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": 2.0000, - * "IsInventoried": null, - * "IsTransported": null, - * "IsGiftCardRecharge": null, - * "ModalType": "" - * } - * ] + * Retrieves a list with the SKUs related to a product by the product's ID. + * + * ### Response body example + * + * ```json + * [ + * { + * "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": 2.0000, + * "IsInventoried": null, + * "IsTransported": null, + * "IsGiftCardRecharge": null, + * "ModalType": "" + * } + * ] * ``` */ "GET /api/catalog_system/pvt/sku/stockkeepingunitByProductId/:productId": { response: SkulistbyProductId[] } /** - * Receives a list of Reference IDs and returns a list with the corresponding SKU IDs. - * - * >⚠️ The list of Reference IDs in the request body cannot have repeated Reference IDs, or the API will return an error 500. - * - * ## Request body example - * - * ```json - * [ - * "123", - * "D25133K-B2", - * "14-556", - * "DCF880L2-BR" - * ] - * ``` - * - * ### Response body example - * - * ```json - * { - * "123": "435", - * "D25133K-B2": "4351", - * "14-556": "3155", - * "DCF880L2-BR": "4500" - * } + * Receives a list of Reference IDs and returns a list with the corresponding SKU IDs. + * + * >⚠️ The list of Reference IDs in the request body cannot have repeated Reference IDs, or the API will return an error 500. + * + * ## Request body example + * + * ```json + * [ + * "123", + * "D25133K-B2", + * "14-556", + * "DCF880L2-BR" + * ] + * ``` + * + * ### Response body example + * + * ```json + * { + * "123": "435", + * "D25133K-B2": "4351", + * "14-556": "3155", + * "DCF880L2-BR": "4500" + * } * ``` */ "POST /api/catalog_system/pub/sku/stockkeepingunitidsbyrefids": { @@ -2374,44 +2374,44 @@ response: { } } /** - * Retrieves a specific SKU by its ID. - * - * ### Response body example - * - * ```json - * { - * "Id": 1, - * "ProductId": 1, - * "IsActive": true, - * "ActivateIfPossible": true, - * "Name": "Ração Royal Canin Feline Urinary 500g", - * "RefId": "0001", - * "PackagedHeight": 6.5000, - * "PackagedLength": 24.0000, - * "PackagedWidth": 14.0000, - * "PackagedWeightKg": 550.0000, - * "Height": 2.2000, - * "Length": 4.4000, - * "Width": 3.3000, - * "WeightKg": 1.1000, - * "CubicWeight": 0.4550, - * "IsKit": false, - * "CreationDate": "2021-06-08T15:25:00", - * "RewardValue": null, - * "EstimatedDateArrival": null, - * "ManufacturerCode": "", - * "CommercialConditionId": 1, - * "MeasurementUnit": "un", - * "UnitMultiplier": 300.0000, - * "ModalType": null, - * "KitItensSellApart": false, - * "Videos": [ - * "www.google.com" - * ] - * } - * ``` - * > 📘 Onboarding guide - * > + * Retrieves a specific SKU by its ID. + * + * ### Response body example + * + * ```json + * { + * "Id": 1, + * "ProductId": 1, + * "IsActive": true, + * "ActivateIfPossible": true, + * "Name": "Ração Royal Canin Feline Urinary 500g", + * "RefId": "0001", + * "PackagedHeight": 6.5000, + * "PackagedLength": 24.0000, + * "PackagedWidth": 14.0000, + * "PackagedWeightKg": 550.0000, + * "Height": 2.2000, + * "Length": 4.4000, + * "Width": 3.3000, + * "WeightKg": 1.1000, + * "CubicWeight": 0.4550, + * "IsKit": false, + * "CreationDate": "2021-06-08T15:25:00", + * "RewardValue": null, + * "EstimatedDateArrival": null, + * "ManufacturerCode": "", + * "CommercialConditionId": 1, + * "MeasurementUnit": "un", + * "UnitMultiplier": 300.0000, + * "ModalType": null, + * "KitItensSellApart": false, + * "Videos": [ + * "www.google.com" + * ] + * } + * ``` + * > 📘 Onboarding guide + * > * > Check the new [Catalog onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. */ "GET /api/catalog/pvt/stockkeepingunit/:skuId": { @@ -2523,72 +2523,72 @@ Videos?: string[] } } /** - * Updates an existing SKU. - * - * ### Request body example - * - * ```json - * { - * "Id": 310118448, - * "ProductId": 310117069, - * "IsActive": true, - * "ActivateIfPossible": true, - * "Name": "sku test", - * "RefId": "125478", - * "PackagedHeight": 10, - * "PackagedLength": 10, - * "PackagedWidth": 10, - * "PackagedWeightKg": 10, - * "Height": null, - * "Length": null, - * "Width": null, - * "WeightKg": null, - * "CubicWeight": 0.1667, - * "IsKit": false, - * "CreationDate": null, - * "RewardValue": null, - * "EstimatedDateArrival": null, - * "ManufacturerCode": "123", - * "CommercialConditionId": 1, - * "MeasurementUnit": "un", - * "UnitMultiplier": 2.0000, - * "ModalType": null, - * "KitItensSellApart": false, - * "Videos": [ "https://www.youtube.com/" ] - * } - * ``` - * - * ### Response body example - * - * ```json - * { - * "Id": 310118449, - * "ProductId": 1, - * "IsActive": true, - * "ActivateIfPossible": true, - * "Name": "sku test", - * "RefId": "1254789", - * "PackagedHeight": 10.0, - * "PackagedLength": 10.0, - * "PackagedWidth": 10.0, - * "PackagedWeightKg": 10.0, - * "Height": null, - * "Length": null, - * "Width": null, - * "WeightKg": null, - * "CubicWeight": 0.1667, - * "IsKit": false, - * "CreationDate": "2020-04-22T12:12:47.5219561", - * "RewardValue": null, - * "EstimatedDateArrival": null, - * "ManufacturerCode": "123", - * "CommercialConditionId": 1, - * "MeasurementUnit": "un", - * "UnitMultiplier": 2.0000, - * "ModalType": null, - * "KitItensSellApart": false, - * "Videos": [ "https://www.youtube.com/" ] - * } + * Updates an existing SKU. + * + * ### Request body example + * + * ```json + * { + * "Id": 310118448, + * "ProductId": 310117069, + * "IsActive": true, + * "ActivateIfPossible": true, + * "Name": "sku test", + * "RefId": "125478", + * "PackagedHeight": 10, + * "PackagedLength": 10, + * "PackagedWidth": 10, + * "PackagedWeightKg": 10, + * "Height": null, + * "Length": null, + * "Width": null, + * "WeightKg": null, + * "CubicWeight": 0.1667, + * "IsKit": false, + * "CreationDate": null, + * "RewardValue": null, + * "EstimatedDateArrival": null, + * "ManufacturerCode": "123", + * "CommercialConditionId": 1, + * "MeasurementUnit": "un", + * "UnitMultiplier": 2.0000, + * "ModalType": null, + * "KitItensSellApart": false, + * "Videos": [ "https://www.youtube.com/" ] + * } + * ``` + * + * ### Response body example + * + * ```json + * { + * "Id": 310118449, + * "ProductId": 1, + * "IsActive": true, + * "ActivateIfPossible": true, + * "Name": "sku test", + * "RefId": "1254789", + * "PackagedHeight": 10.0, + * "PackagedLength": 10.0, + * "PackagedWidth": 10.0, + * "PackagedWeightKg": 10.0, + * "Height": null, + * "Length": null, + * "Width": null, + * "WeightKg": null, + * "CubicWeight": 0.1667, + * "IsKit": false, + * "CreationDate": "2020-04-22T12:12:47.5219561", + * "RewardValue": null, + * "EstimatedDateArrival": null, + * "ManufacturerCode": "123", + * "CommercialConditionId": 1, + * "MeasurementUnit": "un", + * "UnitMultiplier": 2.0000, + * "ModalType": null, + * "KitItensSellApart": false, + * "Videos": [ "https://www.youtube.com/" ] + * } * ``` */ "PUT /api/catalog/pvt/stockkeepingunit/:skuId": { @@ -2802,56 +2802,56 @@ Videos?: string[] } } /** - * Retrieves an existing SKU Complement by its SKU ID. - * - * ## Response body example - * - * ```json - * [ - * { - * "Id": 61, - * "SkuId": 7, - * "ParentSkuId": 1, - * "ComplementTypeId": 1 - * } - * ] + * Retrieves an existing SKU Complement by its SKU ID. + * + * ## Response body example + * + * ```json + * [ + * { + * "Id": 61, + * "SkuId": 7, + * "ParentSkuId": 1, + * "ComplementTypeId": 1 + * } + * ] * ``` */ "GET /api/catalog/pvt/stockkeepingunit/:skuId/complement": { response: SkuComplement } /** - * Retrieves all the existing SKU Complements with the same Complement Type ID of a specific SKU. - * - * ## Response body example - * - * ```json - * [ - * { - * "Id": 61, - * "SkuId": 7, - * "ParentSkuId": 1, - * "ComplementTypeId": 1 - * } - * ] + * Retrieves all the existing SKU Complements with the same Complement Type ID of a specific SKU. + * + * ## Response body example + * + * ```json + * [ + * { + * "Id": 61, + * "SkuId": 7, + * "ParentSkuId": 1, + * "ComplementTypeId": 1 + * } + * ] * ``` */ "GET /api/catalog/pvt/stockkeepingunit/:skuId/complement/:complementTypeId": { response: SkuComplement } /** - * Retrieves all the existing SKU complements with the same complement type ID of a specific SKU. - * - * ## Response body example - * - * ```json - * { - * "ParentSkuId": 1, - * "ComplementSkuIds": [ - * 7 - * ], - * "Type": "1" - * } + * Retrieves all the existing SKU complements with the same complement type ID of a specific SKU. + * + * ## Response body example + * + * ```json + * { + * "ParentSkuId": 1, + * "ComplementSkuIds": [ + * 7 + * ], + * "Type": "1" + * } * ``` */ "GET /api/catalog_system/pvt/sku/complements/:parentSkuId/:type": { @@ -2871,27 +2871,27 @@ Type: string } } /** - * Creates a new SKU Complement on a Parent SKU. - * - * ## Request body example - * - * ```json - * { - * "SkuId": 2, - * "ParentSkuId": 1, - * "ComplementTypeId": 2 - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 62, - * "SkuId": 2, - * "ParentSkuId": 1, - * "ComplementTypeId": 2 - * } + * Creates a new SKU Complement on a Parent SKU. + * + * ## Request body example + * + * ```json + * { + * "SkuId": 2, + * "ParentSkuId": 1, + * "ComplementTypeId": 2 + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 62, + * "SkuId": 2, + * "ParentSkuId": 1, + * "ComplementTypeId": 2 + * } * ``` */ "POST /api/catalog/pvt/skucomplement": { @@ -2912,17 +2912,17 @@ ComplementTypeId: number response: SkuComplement } /** - * Retrieves an existing SKU Complement by its SKU Complement ID. - * - * ## Response body example - * - * ```json - * { - * "Id": 62, - * "SkuId": 2, - * "ParentSkuId": 1, - * "ComplementTypeId": 2 - * } + * Retrieves an existing SKU Complement by its SKU Complement ID. + * + * ## Response body example + * + * ```json + * { + * "Id": 62, + * "SkuId": 2, + * "ParentSkuId": 1, + * "ComplementTypeId": 2 + * } * ``` */ "GET /api/catalog/pvt/skucomplement/:skuComplementId": { @@ -2935,176 +2935,176 @@ response: SkuComplement } /** - * Retrieves an SKU by its EAN ID. - * ## Response body example - * - * ```json - * { - * "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": 2.0000, - * "InformationSource": null, - * "ModalType": "" - * } + * Retrieves an SKU by its EAN ID. + * ## Response body example + * + * ```json + * { + * "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": 2.0000, + * "InformationSource": null, + * "ModalType": "" + * } * ``` */ "GET /api/catalog_system/pvt/sku/stockkeepingunitbyean/:ean": { response: GetSKUAltID } /** - * Retrieves the EAN of the SKU. - * ## Response body example - * - * ```json - * [ - * "1234567890123" - * ] + * Retrieves the EAN of the SKU. + * ## Response body example + * + * ```json + * [ + * "1234567890123" + * ] * ``` */ "GET /api/catalog/pvt/stockkeepingunit/:skuId/ean": { @@ -3132,24 +3132,24 @@ response: string[] } /** - * Associates an existing SKU to an existing Attachment. - * ## Request body example - * - * ```json - * { - * "AttachmentId": 1, - * "SkuId": 7 - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 31, - * "AttachmentId": 1, - * "SkuId": 7 - * } + * Associates an existing SKU to an existing Attachment. + * ## Request body example + * + * ```json + * { + * "AttachmentId": 1, + * "SkuId": 7 + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 31, + * "AttachmentId": 1, + * "SkuId": 7 + * } * ``` */ "POST /api/catalog/pvt/skuattachment": { @@ -3197,17 +3197,17 @@ attachmentId?: number } } /** - * Retrieves existing SKU Attachments by SKU ID. - * ## Response body example - * - * ```json - * [ - * { - * "Id": 97, - * "AttachmentId": 1, - * "SkuId": 1 - * } - * ] + * Retrieves existing SKU Attachments by SKU ID. + * ## Response body example + * + * ```json + * [ + * { + * "Id": 97, + * "AttachmentId": 1, + * "SkuId": 1 + * } + * ] * ``` */ "GET /api/catalog/pvt/stockkeepingunit/:skuId/attachment": { @@ -3237,17 +3237,16 @@ SkuId?: number } /** * Associates attachments to an SKU based on a given SKU ID and attachment names. - * -This request removes existing SKU attachment associations and recreates the associations with the attachments being sent. - * ## Request body example - * - * ```json - * { - * "SkuId": 1, - * "AttachmentNames": [ - * "T-Shirt Customization" - * ] - * } + * This request removes existing SKU attachment associations and recreates the associations with the attachments being sent. + * ## Request body example + * + * ```json + * { + * "SkuId": 1, + * "AttachmentNames": [ + * "T-Shirt Customization" + * ] + * } * ``` */ "POST /api/catalog_system/pvt/sku/associateattachments": { @@ -3263,36 +3262,36 @@ AttachmentNames: string[] } } /** - * Gets general information about all Files in the SKU. - * ## Response body example - * - * ```json - * [ - * { - * "Id": 549, - * "ArchiveId": 155485, - * "SkuId": 310118490, - * "Name": "chimera-cat-quimera-5", - * "IsMain": true, - * "Label": "miau" - * }, - * { - * "Id": 550, - * "ArchiveId": 155486, - * "SkuId": 310118490, - * "Name": "Gato-siames", - * "IsMain": false, - * "Label": "Gato siames" - * }, - * { - * "Id": 555, - * "ArchiveId": 155491, - * "SkuId": 310118490, - * "Name": "Cat-Sleeping-Pics", - * "IsMain": false, - * "Label": null - * } - * ] + * Gets general information about all Files in the SKU. + * ## Response body example + * + * ```json + * [ + * { + * "Id": 549, + * "ArchiveId": 155485, + * "SkuId": 310118490, + * "Name": "chimera-cat-quimera-5", + * "IsMain": true, + * "Label": "miau" + * }, + * { + * "Id": 550, + * "ArchiveId": 155486, + * "SkuId": 310118490, + * "Name": "Gato-siames", + * "IsMain": false, + * "Label": "Gato siames" + * }, + * { + * "Id": 555, + * "ArchiveId": 155491, + * "SkuId": 310118490, + * "Name": "Cat-Sleeping-Pics", + * "IsMain": false, + * "Label": null + * } + * ] * ``` */ "GET /api/catalog/pvt/stockkeepingunit/:skuId/file": { @@ -3327,31 +3326,31 @@ Label?: (null | string) }[] } /** - * Creates a new Image for an SKU based on its URL or on a form-data request body. - * ## Request body example - * - * ```json - * { - * "IsMain": true, - * "Label": "", - * "Name": "Royal-Canin-Feline-Urinary-SO", - * "Text": null, - * "Url": "https://1.bp.blogspot.com/_SLQk9aAv9-o/S7NNbJPv7NI/AAAAAAAAAN8/V1LcO0ViDc4/s1600/waterbottle.jpg" - * - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 503, - * "ArchiveId": 155491, - * "SkuId": 1, - * "Name": "Royal-Canin-Feline-Urinary-SO", - * "IsMain": true, - * "Label": "" - * } + * Creates a new Image for an SKU based on its URL or on a form-data request body. + * ## Request body example + * + * ```json + * { + * "IsMain": true, + * "Label": "", + * "Name": "Royal-Canin-Feline-Urinary-SO", + * "Text": null, + * "Url": "https://1.bp.blogspot.com/_SLQk9aAv9-o/S7NNbJPv7NI/AAAAAAAAAN8/V1LcO0ViDc4/s1600/waterbottle.jpg" + * + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 503, + * "ArchiveId": 155491, + * "SkuId": 1, + * "Name": "Royal-Canin-Feline-Urinary-SO", + * "IsMain": true, + * "Label": "" + * } * ``` */ "POST /api/catalog/pvt/stockkeepingunit/:skuId/file": { @@ -3386,29 +3385,29 @@ Label?: string } /** - * Updates a new Image on an SKU based on its URL or on a form-data request body. - * ## Request body example - * - * ```json - * { - * "IsMain": true, - * "Label": null, - * "Name": "toilet-paper", - * "Text": null, - * "Url": "https://images-na.ssl-images-amazon.com/images/I/81DLLXaGI7L._SL1500_.jpg" - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 508, - * "ArchiveId": 155491, - * "SkuId": 7, - * "IsMain": true, - * "Label": null - * } + * Updates a new Image on an SKU based on its URL or on a form-data request body. + * ## Request body example + * + * ```json + * { + * "IsMain": true, + * "Label": null, + * "Name": "toilet-paper", + * "Text": null, + * "Url": "https://images-na.ssl-images-amazon.com/images/I/81DLLXaGI7L._SL1500_.jpg" + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 508, + * "ArchiveId": 155491, + * "SkuId": 7, + * "IsMain": true, + * "Label": null + * } * ``` */ "PUT /api/catalog/pvt/stockkeepingunit/:skuId/file/:skuFileId": { @@ -3443,26 +3442,26 @@ Label?: string } /** - * Copy all existing files from an SKU to another SKU. - * ## Response body example - * - * ```json - * [ - * { - * "Id": 1964, - * "ArchiveId": 155404, - * "SkuId": 1, - * "IsMain": true, - * "Label": "" - * }, - * { - * "Id": 1965, - * "ArchiveId": 155429, - * "SkuId": 1, - * "IsMain": false, - * "Label": "" - * } - * ] + * Copy all existing files from an SKU to another SKU. + * ## Response body example + * + * ```json + * [ + * { + * "Id": 1964, + * "ArchiveId": 155404, + * "SkuId": 1, + * "IsMain": true, + * "Label": "" + * }, + * { + * "Id": 1965, + * "ArchiveId": 155429, + * "SkuId": 1, + * "IsMain": false, + * "Label": "" + * } + * ] * ``` */ "PUT /api/catalog/pvt/stockkeepingunit/copy/:skuIdfrom/:skuIdto/file/": { @@ -3499,17 +3498,17 @@ Label?: (null | string) } /** - * Retrieves general information about the components of an SKU Kit by SKU ID or Parent SKU ID. - * ## Response body example - * - * ```json - * { - * "Id": 7, - * "StockKeepingUnitParent": 7, - * "StockKeepingUnitId": 1, - * "Quantity": 1, - * "UnitPrice": 50.0000 - * } + * Retrieves general information about the components of an SKU Kit by SKU ID or Parent SKU ID. + * ## Response body example + * + * ```json + * { + * "Id": 7, + * "StockKeepingUnitParent": 7, + * "StockKeepingUnitId": 1, + * "Quantity": 1, + * "UnitPrice": 50.0000 + * } * ``` */ "GET /api/catalog/pvt/stockkeepingunitkit": { @@ -3526,27 +3525,27 @@ parentSkuId?: number response: SkuKit } /** - * Adds a component to a specific Kit. - * ## Request body example - * - * ```json - * { - * "StockKeepingUnitParent": 7, - * "StockKeepingUnitId": 1, - * "Quantity": 1, - * "UnitPrice": 50.0000 - * } - * ``` - * ## Response body example - * - * ```json - * { - * "Id": 7, - * "StockKeepingUnitParent": 7, - * "StockKeepingUnitId": 1, - * "Quantity": 1, - * "UnitPrice": 50.0000 - * } + * Adds a component to a specific Kit. + * ## Request body example + * + * ```json + * { + * "StockKeepingUnitParent": 7, + * "StockKeepingUnitId": 1, + * "Quantity": 1, + * "UnitPrice": 50.0000 + * } + * ``` + * ## Response body example + * + * ```json + * { + * "Id": 7, + * "StockKeepingUnitParent": 7, + * "StockKeepingUnitId": 1, + * "Quantity": 1, + * "UnitPrice": 50.0000 + * } * ``` */ "POST /api/catalog/pvt/stockkeepingunitkit": { @@ -3600,21 +3599,21 @@ response: SkuKit /** * > ⚠️ Check out the updated version of the SKU Seller endpoints in our [SKU Bindings API documentation](https://developers.vtex.com/vtex-rest-api/reference/getbyskuid). If you are doing this integration for the first time, we recommend that you follow the updated documentation. * - * Retrieves the details of a seller's SKU given a seller ID and the SKU ID in the seller's store. - * ## Response body example - * - * ```json - * { - * "IsPersisted": true, - * "IsRemoved": false, - * "SkuSellerId": 799, - * "SellerId": "myseller", - * "StockKeepingUnitId": 50, - * "SellerStockKeepingUnitId": "502", - * "IsActive": true, - * "UpdateDate": "2018-10-11T04:52:42.1", - * "RequestedUpdateDate": null - * } + * Retrieves the details of a seller's SKU given a seller ID and the SKU ID in the seller's store. + * ## Response body example + * + * ```json + * { + * "IsPersisted": true, + * "IsRemoved": false, + * "SkuSellerId": 799, + * "SellerId": "myseller", + * "StockKeepingUnitId": 50, + * "SellerStockKeepingUnitId": "502", + * "IsActive": true, + * "UpdateDate": "2018-10-11T04:52:42.1", + * "RequestedUpdateDate": null + * } * ``` */ "GET /api/catalog_system/pvt/skuseller/:sellerId/:sellerSkuId": { @@ -3680,79 +3679,79 @@ RequestedUpdateDate: (null | string) } /** - * > ⚠️ Check out the updated version of the SKU Seller endpoints in our [SKU Bindings API documentation](https://developers.vtex.com/vtex-rest-api/reference/getbyskuid). If you are doing this integration for the first time, we recommend that you follow the updated documentation. - * - * The seller is responsible for suggesting new SKUs to be sold in the VTEX marketplace and also for informing the marketplace about changes in their SKUs that already exist in the marketplace. Both actions start with a catalog notification, which is made by this request. - * - * With this notification, the seller is telling the marketplace that something has changed about a specific SKU, like its name or description, or that this is a new SKU that the seller would like to offer to the marketplace. The body of the request should be empty. - * - * > ⚠️ Do not use this endpoint for price and inventory changes, because these types of updates should be notified using Marketplace API. For price changes, we recommend using the [Notify marketplace of price update](https://developers.vtex.com/docs/api-reference/marketplace-apis#post-/notificator/-sellerId-/changenotification/-skuId-/price) endpoint. For inventory changes, use [Notify marketplace of inventory update](https://developers.vtex.com/docs/api-reference/marketplace-apis#post-/notificator/-sellerId-/changenotification/-skuId-/inventory). - * - * ## Example - * - * Let's say your seller has the ID `123` in the marketplace and you want to inform the marketplace that has been a change in the SKU with ID `700`. - * - * In this case, you would have to replace the `sellerId` parameter with the value `123` and the `skuId` parameter with the value `700`. The URL of the request would be the following. - * - * ``` - * https://{{accountName}}.vtexcommercestable.com.br/api/catalog_system/pvt/skuseller/changenotification/123/700 - * ``` - * - * ## Response codes - * - * The following response codes are possible for this request. - * - * * **404:** the SKU was not found in the marketplace. The body of the response, in this case, should follow this format: "Seller StockKeepingUnit `{{skuId}}` not found for this seller id `{{sellerId}}`". This means that the seller can now proceed with sending an offer to the marketplace in order to suggest that this SKU is sold there. - * * **200:** the SKU whose ID was informed in the URL already exists in the marketplace and was found. The marketplace can now proceed with a fulfillment simulation in order to get updated information about this SKU's inventory and price. - * * **429:** Failure due to too many requests. + * > ⚠️ Check out the updated version of the SKU Seller endpoints in our [SKU Bindings API documentation](https://developers.vtex.com/vtex-rest-api/reference/getbyskuid). If you are doing this integration for the first time, we recommend that you follow the updated documentation. + * + * The seller is responsible for suggesting new SKUs to be sold in the VTEX marketplace and also for informing the marketplace about changes in their SKUs that already exist in the marketplace. Both actions start with a catalog notification, which is made by this request. + * + * With this notification, the seller is telling the marketplace that something has changed about a specific SKU, like its name or description, or that this is a new SKU that the seller would like to offer to the marketplace. The body of the request should be empty. + * + * > ⚠️ Do not use this endpoint for price and inventory changes, because these types of updates should be notified using Marketplace API. For price changes, we recommend using the [Notify marketplace of price update](https://developers.vtex.com/docs/api-reference/marketplace-apis#post-/notificator/-sellerId-/changenotification/-skuId-/price) endpoint. For inventory changes, use [Notify marketplace of inventory update](https://developers.vtex.com/docs/api-reference/marketplace-apis#post-/notificator/-sellerId-/changenotification/-skuId-/inventory). + * + * ## Example + * + * Let's say your seller has the ID `123` in the marketplace and you want to inform the marketplace that has been a change in the SKU with ID `700`. + * + * In this case, you would have to replace the `sellerId` parameter with the value `123` and the `skuId` parameter with the value `700`. The URL of the request would be the following. + * + * ``` + * https://{{accountName}}.vtexcommercestable.com.br/api/catalog_system/pvt/skuseller/changenotification/123/700 + * ``` + * + * ## Response codes + * + * The following response codes are possible for this request. + * + * * **404:** the SKU was not found in the marketplace. The body of the response, in this case, should follow this format: "Seller StockKeepingUnit `{{skuId}}` not found for this seller id `{{sellerId}}`". This means that the seller can now proceed with sending an offer to the marketplace in order to suggest that this SKU is sold there. + * * **200:** the SKU whose ID was informed in the URL already exists in the marketplace and was found. The marketplace can now proceed with a fulfillment simulation in order to get updated information about this SKU's inventory and price. + * * **429:** Failure due to too many requests. * * **403:** Failure in the authentication. */ "POST /api/catalog_system/pvt/skuseller/changenotification/:skuId": { } /** - * Retrieves an SKU Service. - * ## Response body example - * - * ```json - * { - * "Id": 1, - * "SkuServiceTypeId": 1, - * "SkuServiceValueId": 1, - * "SkuId": 1, - * "Name": "name", - * "Text": "text", - * "IsActive": false - * } + * Retrieves an SKU Service. + * ## Response body example + * + * ```json + * { + * "Id": 1, + * "SkuServiceTypeId": 1, + * "SkuServiceValueId": 1, + * "SkuId": 1, + * "Name": "name", + * "Text": "text", + * "IsActive": false + * } * ``` */ "GET /api/catalog/pvt/skuservice/:skuServiceId": { response: SKUService } /** - * Updates an SKU Service. - * ## Request body example - * - * ```json - * { - * "Name": "name", - * "Text": "text", - * "IsActive": false - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 1, - * "SkuServiceTypeId": 1, - * "SkuServiceValueId": 1, - * "SkuId": 1, - * "Name": "name", - * "Text": "text", - * "IsActive": false - * } + * Updates an SKU Service. + * ## Request body example + * + * ```json + * { + * "Name": "name", + * "Text": "text", + * "IsActive": false + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 1, + * "SkuServiceTypeId": 1, + * "SkuServiceValueId": 1, + * "SkuId": 1, + * "Name": "name", + * "Text": "text", + * "IsActive": false + * } * ``` */ "PUT /api/catalog/pvt/skuservice/:skuServiceId": { @@ -3823,24 +3822,24 @@ IsActive: boolean response: SKUService } /** - * Associates an Attachment for an existing SKU Service Type. - * ## Request body example - * - * ```json - * { - * "AttachmentId": 1, - * "SkuServiceTypeId": 1 - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 1, - * "AttachmentId": 1, - * "SkuServiceTypeId": 1 - * } + * Associates an Attachment for an existing SKU Service Type. + * ## Request body example + * + * ```json + * { + * "AttachmentId": 1, + * "SkuServiceTypeId": 1 + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 1, + * "AttachmentId": 1, + * "SkuServiceTypeId": 1 + * } * ``` */ "POST /api/catalog/pvt/skuservicetypeattachment": { @@ -3891,36 +3890,36 @@ skuServiceTypeId?: number } /** - * Creates a new SKU Service Type. - * ## Request body example - * - * ```json - * { - * "Name": "Test API Sku Services", - * "IsActive": true, - * "ShowOnProductFront": true, - * "ShowOnCartFront": true, - * "ShowOnAttachmentFront": true, - * "ShowOnFileUpload": true, - * "IsGiftCard": true, - * "IsRequired": true - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 2, - * "Name": "Teste API Sku Services", - * "IsActive": true, - * "ShowOnProductFront": true, - * "ShowOnCartFront": true, - * "ShowOnAttachmentFront": true, - * "ShowOnFileUpload": true, - * "IsGiftCard": true, - * "IsRequired": true - * } + * Creates a new SKU Service Type. + * ## Request body example + * + * ```json + * { + * "Name": "Test API Sku Services", + * "IsActive": true, + * "ShowOnProductFront": true, + * "ShowOnCartFront": true, + * "ShowOnAttachmentFront": true, + * "ShowOnFileUpload": true, + * "IsGiftCard": true, + * "IsRequired": true + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 2, + * "Name": "Teste API Sku Services", + * "IsActive": true, + * "ShowOnProductFront": true, + * "ShowOnCartFront": true, + * "ShowOnAttachmentFront": true, + * "ShowOnFileUpload": true, + * "IsGiftCard": true, + * "IsRequired": true + * } * ``` */ "POST /api/catalog/pvt/skuservicetype": { @@ -3928,57 +3927,57 @@ body: SKUServiceTypeRequest response: SKUServiceTypeResponse } /** - * Retrieves information about an existing SKU Service Type. - * ## Response body example: - * - * ```json - * { - * "Id": 2, - * "Name": "Test API SKU Services", - * "IsActive": true, - * "ShowOnProductFront": true, - * "ShowOnCartFront": true, - * "ShowOnAttachmentFront": true, - * "ShowOnFileUpload": true, - * "IsGiftCard": true, - * "IsRequired": true - * } + * Retrieves information about an existing SKU Service Type. + * ## Response body example: + * + * ```json + * { + * "Id": 2, + * "Name": "Test API SKU Services", + * "IsActive": true, + * "ShowOnProductFront": true, + * "ShowOnCartFront": true, + * "ShowOnAttachmentFront": true, + * "ShowOnFileUpload": true, + * "IsGiftCard": true, + * "IsRequired": true + * } * ``` */ "GET /api/catalog/pvt/skuservicetype/:skuServiceTypeId": { response: SKUServiceTypeResponse } /** - * Updates an existing SKU Service Type. - * ## Request body example - * - * ```json - * { - * "Name": "Test API Sku Services", - * "IsActive": true, - * "ShowOnProductFront": true, - * "ShowOnCartFront": true, - * "ShowOnAttachmentFront": true, - * "ShowOnFileUpload": true, - * "IsGiftCard": true, - * "IsRequired": true - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 2, - * "Name": "Teste API Sku Services", - * "IsActive": true, - * "ShowOnProductFront": true, - * "ShowOnCartFront": true, - * "ShowOnAttachmentFront": true, - * "ShowOnFileUpload": true, - * "IsGiftCard": true, - * "IsRequired": true - * } + * Updates an existing SKU Service Type. + * ## Request body example + * + * ```json + * { + * "Name": "Test API Sku Services", + * "IsActive": true, + * "ShowOnProductFront": true, + * "ShowOnCartFront": true, + * "ShowOnAttachmentFront": true, + * "ShowOnFileUpload": true, + * "IsGiftCard": true, + * "IsRequired": true + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 2, + * "Name": "Teste API Sku Services", + * "IsActive": true, + * "ShowOnProductFront": true, + * "ShowOnCartFront": true, + * "ShowOnAttachmentFront": true, + * "ShowOnFileUpload": true, + * "IsGiftCard": true, + * "IsRequired": true + * } * ``` */ "PUT /api/catalog/pvt/skuservicetype/:skuServiceTypeId": { @@ -3992,28 +3991,28 @@ response: SKUServiceTypeResponse } /** - * Creates an SKU Service Value for an existing SKU Service Type. - * ## Request body example - * - * ```json - * { - * "SkuServiceTypeId": 2, - * "Name": "Test ServiceValue API", - * "Value": 10.5, - * "Cost": 10.5 - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 2, - * "SkuServiceTypeId": 2, - * "Name": "Test ServiceValue API", - * "Value": 10.5, - * "Cost": 10.5 - * } + * Creates an SKU Service Value for an existing SKU Service Type. + * ## Request body example + * + * ```json + * { + * "SkuServiceTypeId": 2, + * "Name": "Test ServiceValue API", + * "Value": 10.5, + * "Cost": 10.5 + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 2, + * "SkuServiceTypeId": 2, + * "Name": "Test ServiceValue API", + * "Value": 10.5, + * "Cost": 10.5 + * } * ``` */ "POST /api/catalog/pvt/skuservicevalue": { @@ -4021,45 +4020,45 @@ body: SKUServiceValueRequest response: SKUServiceValueResponse } /** - * Retrieves an existing SKU Service Value. - * ## Response body example - * - * ```json - * { - * "Id": 2, - * "SkuServiceTypeId": 2, - * "Name": "Test ServiceValue API", - * "Value": 10.5, - * "Cost": 10.5 - * } + * Retrieves an existing SKU Service Value. + * ## Response body example + * + * ```json + * { + * "Id": 2, + * "SkuServiceTypeId": 2, + * "Name": "Test ServiceValue API", + * "Value": 10.5, + * "Cost": 10.5 + * } * ``` */ "GET /api/catalog/pvt/skuservicevalue/:skuServiceValueId": { response: SKUServiceValueResponse } /** - * Updates an existing SKU Service Value. - * ## Request body example - * - * ```json - * { - * "SkuServiceTypeId": 2, - * "Name": "Test ServiceValue API", - * "Value": 10.5, - * "Cost": 10.5 - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 2, - * "SkuServiceTypeId": 2, - * "Name": "Test ServiceValue API", - * "Value": 10.5, - * "Cost": 10.5 - * } + * Updates an existing SKU Service Value. + * ## Request body example + * + * ```json + * { + * "SkuServiceTypeId": 2, + * "Name": "Test ServiceValue API", + * "Value": 10.5, + * "Cost": 10.5 + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 2, + * "SkuServiceTypeId": 2, + * "Name": "Test ServiceValue API", + * "Value": 10.5, + * "Cost": 10.5 + * } * ``` */ "PUT /api/catalog/pvt/skuservicevalue/:skuServiceValueId": { @@ -4073,52 +4072,52 @@ response: SKUServiceValueResponse } /** - * Retrieves information about an SKU's Specifications. - * ## Response body example - * - * ```json - * [ - * { - * "Id": 427, - * "SkuId": 7, - * "FieldId": 32, - * "FieldValueId": 131, - * "Text": "500g" - * }, - * { - * "Id": 428, - * "SkuId": 7, - * "FieldId": 40, - * "FieldValueId": 133, - * "Text": "A" - * } - * ] + * Retrieves information about an SKU's Specifications. + * ## Response body example + * + * ```json + * [ + * { + * "Id": 427, + * "SkuId": 7, + * "FieldId": 32, + * "FieldValueId": 131, + * "Text": "500g" + * }, + * { + * "Id": 428, + * "SkuId": 7, + * "FieldId": 40, + * "FieldValueId": 133, + * "Text": "A" + * } + * ] * ``` */ "GET /api/catalog/pvt/stockkeepingunit/:skuId/specification": { response: SKUSpecificationResponse[] } /** - * Associates a previously created Specification to an SKU. - * ## Request body example - * - * ```json - * { - * "FieldId": 65, - * "FieldValueId": 138 - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 730, - * "SkuId": 31, - * "FieldId": 65, - * "FieldValueId": 138, - * "Text": "Size" - * } + * Associates a previously created Specification to an SKU. + * ## Request body example + * + * ```json + * { + * "FieldId": 65, + * "FieldValueId": 138 + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 730, + * "SkuId": 31, + * "FieldId": 65, + * "FieldValueId": 138, + * "Text": "Size" + * } * ``` */ "POST /api/catalog/pvt/stockkeepingunit/:skuId/specification": { @@ -4135,29 +4134,29 @@ FieldValueId?: number response: SKUSpecificationResponse } /** - * Updates an existing Specification on an existing SKU. This endpoint only updates the `FieldValueId`. - * ## Request body example - * - * ```json - * { - * "Id": 65, - * "SkuId": 21, - * "FieldId": 32, - * "FieldValueId": 131, - * "Text": "Red" - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 65, - * "SkuId": 21, - * "FieldId": 32, - * "FieldValueId": 131, - * "Text": "Red" - * } + * Updates an existing Specification on an existing SKU. This endpoint only updates the `FieldValueId`. + * ## Request body example + * + * ```json + * { + * "Id": 65, + * "SkuId": 21, + * "FieldId": 32, + * "FieldValueId": 131, + * "Text": "Red" + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 65, + * "SkuId": 21, + * "FieldId": 32, + * "FieldValueId": 131, + * "Text": "Red" + * } * ``` */ "PUT /api/catalog/pvt/stockkeepingunit/:skuId/specification": { @@ -4198,35 +4197,35 @@ response: SKUSpecificationResponse[] } /** - * Associates a specification to an SKU using specification name and group name. Automatically creates the informed group, specification and values if they had not been created before. - * - * ## Request body example - * - * ```json - * { - * "FieldName": "Size", - * "GroupName": "Sizes", - * "RootLevelSpecification": false, - * "FieldValues": [ - * "M" - * ] - * } - * ``` - * - * - * ## Response body example - * - * ```json - * [ - * { - * "Id": 419, - * "SkuId": 5, - * "FieldId": 22, - * "FieldValueId": 62, - * "Text": "M" - * } - * ] - * ``` + * Associates a specification to an SKU using specification name and group name. Automatically creates the informed group, specification and values if they had not been created before. + * + * ## Request body example + * + * ```json + * { + * "FieldName": "Size", + * "GroupName": "Sizes", + * "RootLevelSpecification": false, + * "FieldValues": [ + * "M" + * ] + * } + * ``` + * + * + * ## Response body example + * + * ```json + * [ + * { + * "Id": 419, + * "SkuId": 5, + * "FieldId": 22, + * "FieldValueId": 62, + * "Text": "M" + * } + * ] + * ``` * */ "PUT /api/catalog/pvt/stockkeepingunit/:skuId/specificationvalue": { @@ -4277,22 +4276,22 @@ Text?: string /** * >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L). * - * Associates a single SKU to a Subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection. - * ## Request body example - * - * ```json - * { - * "SkuId": 1 - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "SubCollectionId": 17, - * "SkuId": 1 - * } + * Associates a single SKU to a Subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection. + * ## Request body example + * + * ```json + * { + * "SkuId": 1 + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "SubCollectionId": 17, + * "SkuId": 1 + * } * ``` */ "POST /api/catalog/pvt/subcollection/:subCollectionId/stockkeepingunit": { @@ -4322,196 +4321,196 @@ SkuId?: number } /** - * 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. - * > 📘 Onboarding guide - * > - * > Check the new [Catalog onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. - * ## Response body example - * - * ```json - * [ - * { - * "id": 1, - * "name": "Alimentação", - * "hasChildren": true, - * "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao", - * "children": [ - * { - * "id": 6, - * "name": "Bebedouro", - * "hasChildren": false, - * "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/bebedouro", - * "children": [], - * "Title": "Bebedouro para Gatos", - * "MetaTagDescription": "" - * }, - * { - * "id": 7, - * "name": "Comedouro", - * "hasChildren": false, - * "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/comedouro", - * "children": [], - * "Title": "Comedouro para Gatos", - * "MetaTagDescription": "" - * }, - * { - * "id": 8, - * "name": "Biscoitos", - * "hasChildren": false, - * "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/biscoitos", - * "children": [], - * "Title": "Biscoitos para Gatos", - * "MetaTagDescription": "" - * }, - * { - * "id": 9, - * "name": "Petiscos", - * "hasChildren": false, - * "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/petiscos", - * "children": [], - * "Title": "Petiscos para Gatos", - * "MetaTagDescription": "" - * }, - * { - * "id": 10, - * "name": "Ração Seca", - * "hasChildren": false, - * "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/racao-seca", - * "children": [], - * "Title": "Ração Seca para Gatos", - * "MetaTagDescription": "" - * }, - * { - * "id": 11, - * "name": "Ração Úmida", - * "hasChildren": false, - * "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/racao-umida", - * "children": [], - * "Title": "Ração Úmida para Gatos", - * "MetaTagDescription": "" - * } - * ], - * "Title": "Alimentação para Gatos", - * "MetaTagDescription": "" - * }, - * { - * "id": 2, - * "name": "Brinquedos", - * "hasChildren": true, - * "url": "https://lojadobreno.vtexcommercestable.com.br/brinquedos", - * "children": [ - * { - * "id": 12, - * "name": "Bolinhas", - * "hasChildren": false, - * "url": "https://lojadobreno.vtexcommercestable.com.br/brinquedos/bolinhas", - * "children": [], - * "Title": "Bolinhas para Gatos", - * "MetaTagDescription": "" - * }, - * { - * "id": 13, - * "name": "Ratinhos", - * "hasChildren": false, - * "url": "https://lojadobreno.vtexcommercestable.com.br/brinquedos/ratinhos", - * "children": [], - * "Title": "Ratinhos", - * "MetaTagDescription": "" - * }, - * { - * "id": 19, - * "name": "Arranhador para gato", - * "hasChildren": false, - * "url": "https://lojadobreno.vtexcommercestable.com.br/brinquedos/arranhador-para-gato", - * "children": [], - * "Title": "Brinquedo Arranhador para gatos", - * "MetaTagDescription": "Arranhador gatos é indispensável no lar com felinos. Ideais para afiar as unhas e garantir a diversão" - * } - * ], - * "Title": "Brinquedos para Gatos", - * "MetaTagDescription": "" - * } - * ] + * 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. + * > 📘 Onboarding guide + * > + * > Check the new [Catalog onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Catalog and is organized by focusing on the developer's journey. + * ## Response body example + * + * ```json + * [ + * { + * "id": 1, + * "name": "Alimentação", + * "hasChildren": true, + * "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao", + * "children": [ + * { + * "id": 6, + * "name": "Bebedouro", + * "hasChildren": false, + * "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/bebedouro", + * "children": [], + * "Title": "Bebedouro para Gatos", + * "MetaTagDescription": "" + * }, + * { + * "id": 7, + * "name": "Comedouro", + * "hasChildren": false, + * "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/comedouro", + * "children": [], + * "Title": "Comedouro para Gatos", + * "MetaTagDescription": "" + * }, + * { + * "id": 8, + * "name": "Biscoitos", + * "hasChildren": false, + * "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/biscoitos", + * "children": [], + * "Title": "Biscoitos para Gatos", + * "MetaTagDescription": "" + * }, + * { + * "id": 9, + * "name": "Petiscos", + * "hasChildren": false, + * "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/petiscos", + * "children": [], + * "Title": "Petiscos para Gatos", + * "MetaTagDescription": "" + * }, + * { + * "id": 10, + * "name": "Ração Seca", + * "hasChildren": false, + * "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/racao-seca", + * "children": [], + * "Title": "Ração Seca para Gatos", + * "MetaTagDescription": "" + * }, + * { + * "id": 11, + * "name": "Ração Úmida", + * "hasChildren": false, + * "url": "https://lojadobreno.vtexcommercestable.com.br/alimentacao/racao-umida", + * "children": [], + * "Title": "Ração Úmida para Gatos", + * "MetaTagDescription": "" + * } + * ], + * "Title": "Alimentação para Gatos", + * "MetaTagDescription": "" + * }, + * { + * "id": 2, + * "name": "Brinquedos", + * "hasChildren": true, + * "url": "https://lojadobreno.vtexcommercestable.com.br/brinquedos", + * "children": [ + * { + * "id": 12, + * "name": "Bolinhas", + * "hasChildren": false, + * "url": "https://lojadobreno.vtexcommercestable.com.br/brinquedos/bolinhas", + * "children": [], + * "Title": "Bolinhas para Gatos", + * "MetaTagDescription": "" + * }, + * { + * "id": 13, + * "name": "Ratinhos", + * "hasChildren": false, + * "url": "https://lojadobreno.vtexcommercestable.com.br/brinquedos/ratinhos", + * "children": [], + * "Title": "Ratinhos", + * "MetaTagDescription": "" + * }, + * { + * "id": 19, + * "name": "Arranhador para gato", + * "hasChildren": false, + * "url": "https://lojadobreno.vtexcommercestable.com.br/brinquedos/arranhador-para-gato", + * "children": [], + * "Title": "Brinquedo Arranhador para gatos", + * "MetaTagDescription": "Arranhador gatos é indispensável no lar com felinos. Ideais para afiar as unhas e garantir a diversão" + * } + * ], + * "Title": "Brinquedos para Gatos", + * "MetaTagDescription": "" + * } + * ] * ``` */ "GET /api/catalog_system/pub/category/tree/:categoryLevels": { response: GetCategoryTree[] } /** - * Retrieves general information about a Category. - * ## Response body example - * - * ```json - * { - * "Id": 1, - * "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": 3367, - * "StockKeepingUnitSelectionMode": "LIST", - * "Score": null, - * "LinkId": "Alimentacao", - * "HasChildren": true - * } + * Retrieves general information about a Category. + * ## Response body example + * + * ```json + * { + * "Id": 1, + * "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": 3367, + * "StockKeepingUnitSelectionMode": "LIST", + * "Score": null, + * "LinkId": "Alimentacao", + * "HasChildren": true + * } * ``` */ "GET /api/catalog/pvt/category/:categoryId": { response: Category } /** - * Updates a previously existing Category. - * - * ## Request body example - * - * ```json - * { - * "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": null, - * "AdWordsRemarketingCode": null, - * "ShowInStoreFront": true, - * "ShowBrandFilter": true, - * "ActiveStoreFrontLink": true, - * "GlobalCategoryId": 604, - * "StockKeepingUnitSelectionMode": "SPECIFICATION", - * "Score": null - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 1, - * "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": 604, - * "StockKeepingUnitSelectionMode": "LIST", - * "Score": null, - * "LinkId": "Alimentacao", - * "HasChildren": true - * } + * Updates a previously existing Category. + * + * ## Request body example + * + * ```json + * { + * "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": null, + * "AdWordsRemarketingCode": null, + * "ShowInStoreFront": true, + * "ShowBrandFilter": true, + * "ActiveStoreFrontLink": true, + * "GlobalCategoryId": 604, + * "StockKeepingUnitSelectionMode": "SPECIFICATION", + * "Score": null + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 1, + * "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": 604, + * "StockKeepingUnitSelectionMode": "LIST", + * "Score": null, + * "LinkId": "Alimentacao", + * "HasChildren": true + * } * ``` */ "PUT /api/catalog/pvt/category/:categoryId": { @@ -4578,75 +4577,75 @@ StockKeepingUnitSelectionMode: string response: Category } /** - * Creates a new Category. - * - * If there is a need to create a new category with a specific custom ID, specify the `Id` (integer) in the request. Otherwise, VTEX will generate the ID automatically. - * - * ## Request body example (automatically generated ID) - * - * ```json - * { - * "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": null, - * "AdWordsRemarketingCode": null, - * "ShowInStoreFront": true, - * "ShowBrandFilter": true, - * "ActiveStoreFrontLink": true, - * "GlobalCategoryId": 604, - * "StockKeepingUnitSelectionMode": "SPECIFICATION", - * "Score": null - * } - * ``` - * - * ## Request body example (custom ID) - * - * ```json - * { - * "Id": 1, - * "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": null, - * "AdWordsRemarketingCode": null, - * "ShowInStoreFront": true, - * "ShowBrandFilter": true, - * "ActiveStoreFrontLink": true, - * "GlobalCategoryId": 604, - * "StockKeepingUnitSelectionMode": "SPECIFICATION", - * "Score": null - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 1, - * "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": 604, - * "StockKeepingUnitSelectionMode": "LIST", - * "Score": null, - * "LinkId": "Alimentacao", - * "HasChildren": true - * } + * Creates a new Category. + * + * If there is a need to create a new category with a specific custom ID, specify the `Id` (integer) in the request. Otherwise, VTEX will generate the ID automatically. + * + * ## Request body example (automatically generated ID) + * + * ```json + * { + * "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": null, + * "AdWordsRemarketingCode": null, + * "ShowInStoreFront": true, + * "ShowBrandFilter": true, + * "ActiveStoreFrontLink": true, + * "GlobalCategoryId": 604, + * "StockKeepingUnitSelectionMode": "SPECIFICATION", + * "Score": null + * } + * ``` + * + * ## Request body example (custom ID) + * + * ```json + * { + * "Id": 1, + * "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": null, + * "AdWordsRemarketingCode": null, + * "ShowInStoreFront": true, + * "ShowBrandFilter": true, + * "ActiveStoreFrontLink": true, + * "GlobalCategoryId": 604, + * "StockKeepingUnitSelectionMode": "SPECIFICATION", + * "Score": null + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 1, + * "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": 604, + * "StockKeepingUnitSelectionMode": "LIST", + * "Score": null, + * "LinkId": "Alimentacao", + * "HasChildren": true + * } * ``` */ "POST /api/catalog/pvt/category": { @@ -4654,21 +4653,21 @@ body: CreateCategoryRequest response: Category } /** - * Retrieves Similar Categories from a Product. - * - * ## Response body example - * - * ```json - * [ - * { - * "ProductId": 1, - * "CategoryId": 1 - * }, - * { - * "ProductId": 1, - * "CategoryId": 20 - * } - * ] + * Retrieves Similar Categories from a Product. + * + * ## Response body example + * + * ```json + * [ + * { + * "ProductId": 1, + * "CategoryId": 1 + * }, + * { + * "ProductId": 1, + * "CategoryId": 20 + * } + * ] * ``` */ "GET /api/catalog/pvt/product/:productId/similarcategory/": { @@ -4687,15 +4686,15 @@ CategoryId?: number }[] } /** - * Adds a Similar Category to a Product. - * - * ## Response body example - * - * ```json - * { - * "ProductId": 1, - * "StoreId": 1 - * } + * Adds a Similar Category to a Product. + * + * ## Response body example + * + * ```json + * { + * "ProductId": 1, + * "StoreId": 1 + * } * ``` */ "POST /api/catalog/pvt/product/:productId/similarcategory/:categoryId": { @@ -4720,68 +4719,68 @@ StoreId?: number } /** - * Retrieves all specifications from a category by its ID. - * - * ## Response body example - * - * ```json - * [ - * { - * "Name": "Specification A", - * "CategoryId": 1, - * "FieldId": 33, - * "IsActive": true, - * "IsStockKeepingUnit": false - * }, - * { - * "Name": "Specification B", - * "CategoryId": 1, - * "FieldId": 34, - * "IsActive": true, - * "IsStockKeepingUnit": false - * }, - * { - * "Name": "Specification C", - * "CategoryId": 1, - * "FieldId": 35, - * "IsActive": false, - * "IsStockKeepingUnit": false - * } - * ] + * Retrieves all specifications from a category by its ID. + * + * ## Response body example + * + * ```json + * [ + * { + * "Name": "Specification A", + * "CategoryId": 1, + * "FieldId": 33, + * "IsActive": true, + * "IsStockKeepingUnit": false + * }, + * { + * "Name": "Specification B", + * "CategoryId": 1, + * "FieldId": 34, + * "IsActive": true, + * "IsStockKeepingUnit": false + * }, + * { + * "Name": "Specification C", + * "CategoryId": 1, + * "FieldId": 35, + * "IsActive": false, + * "IsStockKeepingUnit": false + * } + * ] * ``` */ "GET /api/catalog_system/pub/specification/field/listByCategoryId/:categoryId": { response: CategorySpecification } /** - * Lists all specifications including the current category and the level zero specifications from a category by its ID. - * - * ## Response body example - * - * ```json - * [ - * { - * "Name": "Specification A", - * "CategoryId": 1, - * "FieldId": 33, - * "IsActive": true, - * "IsStockKeepingUnit": false - * }, - * { - * "Name": "Specification B", - * "CategoryId": 1, - * "FieldId": 34, - * "IsActive": true, - * "IsStockKeepingUnit": false - * }, - * { - * "Name": "Specification C", - * "CategoryId": 1, - * "FieldId": 35, - * "IsActive": false, - * "IsStockKeepingUnit": false - * } - * ] + * Lists all specifications including the current category and the level zero specifications from a category by its ID. + * + * ## Response body example + * + * ```json + * [ + * { + * "Name": "Specification A", + * "CategoryId": 1, + * "FieldId": 33, + * "IsActive": true, + * "IsStockKeepingUnit": false + * }, + * { + * "Name": "Specification B", + * "CategoryId": 1, + * "FieldId": 34, + * "IsActive": true, + * "IsStockKeepingUnit": false + * }, + * { + * "Name": "Specification C", + * "CategoryId": 1, + * "FieldId": 35, + * "IsActive": false, + * "IsStockKeepingUnit": false + * } + * ] * ``` */ "GET /api/catalog_system/pub/specification/field/listTreeByCategoryId/:categoryId": { @@ -4790,22 +4789,22 @@ response: CategorySpecification /** * >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L). * - * Associates a single Category to a Subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection. - * ## Request body example - * - * ```json - * { - * "CategoryId": 1 - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "SubCollectionId": 17, - * "CategoryId": 1 - * } + * Associates a single Category to a Subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection. + * ## Request body example + * + * ```json + * { + * "CategoryId": 1 + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "SubCollectionId": 17, + * "CategoryId": 1 + * } * ``` */ "POST /api/catalog/pvt/subcollection/:subCollectionId/category": { @@ -4835,37 +4834,37 @@ CategoryId?: number } /** - * Retrieves all Brands registered in the store's Catalog. - * >⚠️ This route's response is limited to 20k results. If you need to obtain more results, please use the [Get Brand List](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-brand-list) endpoint instead to get a paginated response. - * ## Response body example - * - * ```json - * [ - * { - * "id": 9280, - * "name": "Brand", - * "isActive": true, - * "title": "Brand", - * "metaTagDescription": "Brand", - * "imageUrl": null - * }, - * { - * "id": 2000000, - * "name": "Orma Carbon", - * "isActive": true, - * "title": "Orma Carbon", - * "metaTagDescription": "Orma Carbon", - * "imageUrl": null - * }, - * { - * "id": 2000001, - * "name": "Pedigree", - * "isActive": true, - * "title": "Pedigree", - * "metaTagDescription": "", - * "imageUrl": null - * } - * ] + * Retrieves all Brands registered in the store's Catalog. + * >⚠️ This route's response is limited to 20k results. If you need to obtain more results, please use the [Get Brand List](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-brand-list) endpoint instead to get a paginated response. + * ## Response body example + * + * ```json + * [ + * { + * "id": 9280, + * "name": "Brand", + * "isActive": true, + * "title": "Brand", + * "metaTagDescription": "Brand", + * "imageUrl": null + * }, + * { + * "id": 2000000, + * "name": "Orma Carbon", + * "isActive": true, + * "title": "Orma Carbon", + * "metaTagDescription": "Orma Carbon", + * "imageUrl": null + * }, + * { + * "id": 2000001, + * "name": "Pedigree", + * "isActive": true, + * "title": "Pedigree", + * "metaTagDescription": "", + * "imageUrl": null + * } + * ] * ``` */ "GET /api/catalog_system/pvt/brand/list": { @@ -4875,44 +4874,44 @@ CategoryId?: number response: BrandGet[] } /** - * Retrieves all Brands registered in the store's Catalog by page number. - * ## Response body example - * - * ```json - * { - * "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 - * } - * } + * Retrieves all Brands registered in the store's Catalog by page number. + * ## Response body example + * + * ```json + * { + * "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 + * } + * } * ``` */ "GET /api/catalog_system/pvt/brand/pagedlist": { @@ -4955,41 +4954,41 @@ pages: number } } /** - * Retrieves a specific Brand by its ID. - * ## Response body example - * - * ```json - * { - * "id": 7000000, - * "name": "Pedigree", - * "isActive": true, - * "title": "Pedigree", - * "metaTagDescription": "Pedigree", - * "imageUrl": null - * } + * Retrieves a specific Brand by its ID. + * ## Response body example + * + * ```json + * { + * "id": 7000000, + * "name": "Pedigree", + * "isActive": true, + * "title": "Pedigree", + * "metaTagDescription": "Pedigree", + * "imageUrl": null + * } * ``` */ "GET /api/catalog_system/pvt/brand/:brandId": { response: BrandGet } /** - * Creates a new Brand. - * ## Request and response body example - * - * ```json - * { - * "Id": 2000013, - * "Name": "Orma Carbon", - * "Text": "Orma Carbon", - * "Keywords": "orma", - * "SiteTitle": "Orma Carbon", - * "Active": true, - * "MenuHome": true, - * "AdWordsRemarketingCode": "", - * "LomadeeCampaignCode": "", - * "Score": null, - * "LinkId": "orma-carbon" - * } + * Creates a new Brand. + * ## Request and response body example + * + * ```json + * { + * "Id": 2000013, + * "Name": "Orma Carbon", + * "Text": "Orma Carbon", + * "Keywords": "orma", + * "SiteTitle": "Orma Carbon", + * "Active": true, + * "MenuHome": true, + * "AdWordsRemarketingCode": "", + * "LomadeeCampaignCode": "", + * "Score": null, + * "LinkId": "orma-carbon" + * } * ``` */ "POST /api/catalog/pvt/brand": { @@ -4997,46 +4996,46 @@ body: BrandCreateUpdate response: BrandCreateUpdate } /** - * Retrieves information about a specific Brand and its context. - * ## Response body example - * - * ```json - * { - * "Id": 2000013, - * "Name": "Orma Carbon", - * "Text": "Orma Carbon", - * "Keywords": "orma", - * "SiteTitle": "Orma Carbon", - * "Active": true, - * "MenuHome": true, - * "AdWordsRemarketingCode": "", - * "LomadeeCampaignCode": "", - * "Score": null, - * "LinkId": "orma-carbon" - * } + * Retrieves information about a specific Brand and its context. + * ## Response body example + * + * ```json + * { + * "Id": 2000013, + * "Name": "Orma Carbon", + * "Text": "Orma Carbon", + * "Keywords": "orma", + * "SiteTitle": "Orma Carbon", + * "Active": true, + * "MenuHome": true, + * "AdWordsRemarketingCode": "", + * "LomadeeCampaignCode": "", + * "Score": null, + * "LinkId": "orma-carbon" + * } * ``` */ "GET /api/catalog/pvt/brand/:brandId": { response: BrandCreateUpdate } /** - * Updates a previously existing Brand. - * ## Request and response body example - * - * ```json - * { - * "Id": 2000013, - * "Name": "Orma Carbon", - * "Text": "Orma Carbon", - * "Keywords": "orma", - * "SiteTitle": "Orma Carbon", - * "Active": true, - * "MenuHome": true, - * "AdWordsRemarketingCode": "", - * "LomadeeCampaignCode": "", - * "Score": null, - * "LinkId": "orma-carbon" - * } + * Updates a previously existing Brand. + * ## Request and response body example + * + * ```json + * { + * "Id": 2000013, + * "Name": "Orma Carbon", + * "Text": "Orma Carbon", + * "Keywords": "orma", + * "SiteTitle": "Orma Carbon", + * "Active": true, + * "MenuHome": true, + * "AdWordsRemarketingCode": "", + * "LomadeeCampaignCode": "", + * "Score": null, + * "LinkId": "orma-carbon" + * } * ``` */ "PUT /api/catalog/pvt/brand/:brandId": { @@ -5052,22 +5051,22 @@ response: BrandCreateUpdate /** * >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L). * - * Associates a single Brand to a Subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection. - * ## Request body example - * - * ```json - * { - * "BrandId": 2000000 - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "SubCollectionId": 17, - * "BrandId": 2000000 - * } + * Associates a single Brand to a Subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection. + * ## Request body example + * + * ```json + * { + * "BrandId": 2000000 + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "SubCollectionId": 17, + * "BrandId": 2000000 + * } * ``` */ "POST /api/catalog/pvt/subcollection/:subCollectionId/brand": { @@ -5097,79 +5096,79 @@ BrandId?: number } /** - * Gets information about a registered attachment. - * >⚠️ To understand the specific syntax for Assembly Options attachments, read the [Assembly Options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH#assembly-options-syntax) documentation. - * ## Response body example - * - * ```json - * { - * "Id": 8, - * "Name": "Test", - * "IsRequired": true, - * "IsActive": true, - * "Domains": [ - * { - * "FieldName": "Basic test", - * "MaxCaracters": "", - * "DomainValues": "[1-2]#9[1-1][1]basic;#11[0-1][1]basic" - * }, - * { - * "FieldName": "teste", - * "MaxCaracters": "", - * "DomainValues": "[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium" - * } - * ] - * } + * Gets information about a registered attachment. + * >⚠️ To understand the specific syntax for Assembly Options attachments, read the [Assembly Options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH#assembly-options-syntax) documentation. + * ## Response body example + * + * ```json + * { + * "Id": 8, + * "Name": "Test", + * "IsRequired": true, + * "IsActive": true, + * "Domains": [ + * { + * "FieldName": "Basic test", + * "MaxCaracters": "", + * "DomainValues": "[1-2]#9[1-1][1]basic;#11[0-1][1]basic" + * }, + * { + * "FieldName": "teste", + * "MaxCaracters": "", + * "DomainValues": "[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium" + * } + * ] + * } * ``` */ "GET /api/catalog/pvt/attachment/:attachmentid": { response: AttachmentResponse } /** - * Updates a previously existing SKU attachment with new information. - * >⚠️ To understand the specific syntax for Assembly Options attachments, read the [Assembly Options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH#assembly-options-syntax) documentation. - * ## Request body example - * - * ```json - * { - * "Name": "Test", - * "IsRequired": true, - * "IsActive": true, - * "Domains": [ - * { - * "FieldName": "Basic test", - * "MaxCaracters": "", - * "DomainValues": "[1-2]#9[1-1][1]basic;#11[0-1][1]basic" - * }, - * { - * "FieldName": "teste", - * "MaxCaracters": "", - * "DomainValues": "[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium" - * } - * ] - * } - * ``` - * ## Response body example - * - * ```json - * { - * "Id": 8, - * "Name": "Test", - * "IsRequired": true, - * "IsActive": true, - * "Domains": [ - * { - * "FieldName": "Basic test", - * "MaxCaracters": "", - * "DomainValues": "[1-2]#9[1-1][1]basic;#11[0-1][1]basic" - * }, - * { - * "FieldName": "teste", - * "MaxCaracters": "", - * "DomainValues": "[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium" - * } - * ] - * } + * Updates a previously existing SKU attachment with new information. + * >⚠️ To understand the specific syntax for Assembly Options attachments, read the [Assembly Options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH#assembly-options-syntax) documentation. + * ## Request body example + * + * ```json + * { + * "Name": "Test", + * "IsRequired": true, + * "IsActive": true, + * "Domains": [ + * { + * "FieldName": "Basic test", + * "MaxCaracters": "", + * "DomainValues": "[1-2]#9[1-1][1]basic;#11[0-1][1]basic" + * }, + * { + * "FieldName": "teste", + * "MaxCaracters": "", + * "DomainValues": "[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium" + * } + * ] + * } + * ``` + * ## Response body example + * + * ```json + * { + * "Id": 8, + * "Name": "Test", + * "IsRequired": true, + * "IsActive": true, + * "Domains": [ + * { + * "FieldName": "Basic test", + * "MaxCaracters": "", + * "DomainValues": "[1-2]#9[1-1][1]basic;#11[0-1][1]basic" + * }, + * { + * "FieldName": "teste", + * "MaxCaracters": "", + * "DomainValues": "[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium" + * } + * ] + * } * ``` */ "PUT /api/catalog/pvt/attachment/:attachmentid": { @@ -5183,50 +5182,50 @@ response: AttachmentResponse } /** - * Creates a new SKU attachment. - * >⚠️ To understand the specific syntax for Assembly Options attachments, read the [Assembly Options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH#assembly-options-syntax) documentation. - * ## Request body example - * - * ```json - * { - * "Name": "Test", - * "IsRequired": true, - * "IsActive": true, - * "Domains": [ - * { - * "FieldName": "Basic test", - * "MaxCaracters": "", - * "DomainValues": "[1-2]#9[1-1][1]basic;#11[0-1][1]basic" - * }, - * { - * "FieldName": "teste", - * "MaxCaracters": "", - * "DomainValues": "[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium" - * } - * ] - * } - * ``` - * ## Response body example - * - * ```json - * { - * "Id": 8, - * "Name": "Test", - * "IsRequired": true, - * "IsActive": true, - * "Domains": [ - * { - * "FieldName": "Basic test", - * "MaxCaracters": "", - * "DomainValues": "[1-2]#9[1-1][1]basic;#11[0-1][1]basic" - * }, - * { - * "FieldName": "teste", - * "MaxCaracters": "", - * "DomainValues": "[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium" - * } - * ] - * } + * Creates a new SKU attachment. + * >⚠️ To understand the specific syntax for Assembly Options attachments, read the [Assembly Options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH#assembly-options-syntax) documentation. + * ## Request body example + * + * ```json + * { + * "Name": "Test", + * "IsRequired": true, + * "IsActive": true, + * "Domains": [ + * { + * "FieldName": "Basic test", + * "MaxCaracters": "", + * "DomainValues": "[1-2]#9[1-1][1]basic;#11[0-1][1]basic" + * }, + * { + * "FieldName": "teste", + * "MaxCaracters": "", + * "DomainValues": "[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium" + * } + * ] + * } + * ``` + * ## Response body example + * + * ```json + * { + * "Id": 8, + * "Name": "Test", + * "IsRequired": true, + * "IsActive": true, + * "Domains": [ + * { + * "FieldName": "Basic test", + * "MaxCaracters": "", + * "DomainValues": "[1-2]#9[1-1][1]basic;#11[0-1][1]basic" + * }, + * { + * "FieldName": "teste", + * "MaxCaracters": "", + * "DomainValues": "[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium" + * } + * ] + * } * ``` */ "POST /api/catalog/pvt/attachment": { @@ -5234,151 +5233,151 @@ body: AttachmentRequest response: AttachmentResponse } /** - * Retrieves information about all registered attachments. - * >⚠️ To understand the specific syntax for Assembly Options attachments, read the [Assembly Options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH#assembly-options-syntax) documentation. - * ## Response body example - * - * ```json - * { - * "Page": 1, - * "Size": 11, - * "TotalRows": 11, - * "TotalPage": 1, - * "Data": [ - * { - * "Id": 1, - * "Name": "Acessórios do bicho", - * "IsRequired": true, - * "IsActive": true, - * "Domains": [ - * { - * "FieldName": "extra", - * "MaxCaracters": "", - * "DomainValues": "[0-3]#1[1-2][1]pricetable1;#3[0-2][0]pricetable2;#5[0-2][0]pricetable3" - * } - * ] - * }, - * { - * "Id": 2, - * "Name": "Sobrenome", - * "IsRequired": false, - * "IsActive": true, - * "Domains": [] - * }, - * { - * "Id": 3, - * "Name": "Assinatura Teste", - * "IsRequired": false, - * "IsActive": true, - * "Domains": [ - * { - * "FieldName": " vtex.subscription.key.frequency", - * "MaxCaracters": "", - * "DomainValues": "1 day, 7 day, 1 month, 6 month" - * }, - * { - * "FieldName": "vtex.subscription.key.validity.begin", - * "MaxCaracters": "", - * "DomainValues": "1" - * }, - * { - * "FieldName": "vtex.subscription.key.validity.end", - * "MaxCaracters": "", - * "DomainValues": "31" - * }, - * { - * "FieldName": "vtex.subscription.key.purchaseday", - * "MaxCaracters": "", - * "DomainValues": "1, 2, 20, 31" - * } - * ] - * }, - * { - * "Id": 5, - * "Name": "teste", - * "IsRequired": false, - * "IsActive": true, - * "Domains": [] - * }, - * { - * "Id": 6, - * "Name": "teste2", - * "IsRequired": false, - * "IsActive": true, - * "Domains": [] - * }, - * { - * "Id": 7, - * "Name": "vtex.subscription.teste3", - * "IsRequired": false, - * "IsActive": true, - * "Domains": [] - * }, - * { - * "Id": 8, - * "Name": "teste api nova", - * "IsRequired": true, - * "IsActive": true, - * "Domains": [ - * { - * "FieldName": "Basic teste", - * "MaxCaracters": "", - * "DomainValues": "[1-2]#9[1-1][1]basic;#11[0-1][1]basic" - * }, - * { - * "FieldName": "teste", - * "MaxCaracters": "", - * "DomainValues": "[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium" - * } - * ] - * }, - * { - * "Id": 9, - * "Name": "vtex.subscription.teste", - * "IsRequired": false, - * "IsActive": true, - * "Domains": [] - * }, - * { - * "Id": 10, - * "Name": "Montagens", - * "IsRequired": false, - * "IsActive": true, - * "Domains": [] - * }, - * { - * "Id": 11, - * "Name": "vtex.subscription.subscription", - * "IsRequired": false, - * "IsActive": true, - * "Domains": [ - * { - * "FieldName": "vtex.subscription.key.frequency", - * "MaxCaracters": "15", - * "DomainValues": "1 month" - * }, - * { - * "FieldName": "vtex.subscription.key.purchaseday", - * "MaxCaracters": "15", - * "DomainValues": "1,15,28" - * } - * ] - * }, - * { - * "Id": 12, - * "Name": "T-Shirt Customization", - * "IsRequired": false, - * "IsActive": true, - * "Domains": [ - * { - * "FieldName": "T-Shirt Name", - * "MaxCaracters": "15", - * "DomainValues": "[]" - * } - * ] - * } - * ] - * } + * Retrieves information about all registered attachments. + * >⚠️ To understand the specific syntax for Assembly Options attachments, read the [Assembly Options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH#assembly-options-syntax) documentation. + * ## Response body example + * + * ```json + * { + * "Page": 1, + * "Size": 11, + * "TotalRows": 11, + * "TotalPage": 1, + * "Data": [ + * { + * "Id": 1, + * "Name": "Acessórios do bicho", + * "IsRequired": true, + * "IsActive": true, + * "Domains": [ + * { + * "FieldName": "extra", + * "MaxCaracters": "", + * "DomainValues": "[0-3]#1[1-2][1]pricetable1;#3[0-2][0]pricetable2;#5[0-2][0]pricetable3" + * } + * ] + * }, + * { + * "Id": 2, + * "Name": "Sobrenome", + * "IsRequired": false, + * "IsActive": true, + * "Domains": [] + * }, + * { + * "Id": 3, + * "Name": "Assinatura Teste", + * "IsRequired": false, + * "IsActive": true, + * "Domains": [ + * { + * "FieldName": " vtex.subscription.key.frequency", + * "MaxCaracters": "", + * "DomainValues": "1 day, 7 day, 1 month, 6 month" + * }, + * { + * "FieldName": "vtex.subscription.key.validity.begin", + * "MaxCaracters": "", + * "DomainValues": "1" + * }, + * { + * "FieldName": "vtex.subscription.key.validity.end", + * "MaxCaracters": "", + * "DomainValues": "31" + * }, + * { + * "FieldName": "vtex.subscription.key.purchaseday", + * "MaxCaracters": "", + * "DomainValues": "1, 2, 20, 31" + * } + * ] + * }, + * { + * "Id": 5, + * "Name": "teste", + * "IsRequired": false, + * "IsActive": true, + * "Domains": [] + * }, + * { + * "Id": 6, + * "Name": "teste2", + * "IsRequired": false, + * "IsActive": true, + * "Domains": [] + * }, + * { + * "Id": 7, + * "Name": "vtex.subscription.teste3", + * "IsRequired": false, + * "IsActive": true, + * "Domains": [] + * }, + * { + * "Id": 8, + * "Name": "teste api nova", + * "IsRequired": true, + * "IsActive": true, + * "Domains": [ + * { + * "FieldName": "Basic teste", + * "MaxCaracters": "", + * "DomainValues": "[1-2]#9[1-1][1]basic;#11[0-1][1]basic" + * }, + * { + * "FieldName": "teste", + * "MaxCaracters": "", + * "DomainValues": "[0-10]#8[0-3][0]medium;#9[0-3][0]medium;#10[0-3][0]medium;#11[0-3][0]medium;#36[0-3][0]medium;#37[0-3][0]medium;#38[0-3][0]medium" + * } + * ] + * }, + * { + * "Id": 9, + * "Name": "vtex.subscription.teste", + * "IsRequired": false, + * "IsActive": true, + * "Domains": [] + * }, + * { + * "Id": 10, + * "Name": "Montagens", + * "IsRequired": false, + * "IsActive": true, + * "Domains": [] + * }, + * { + * "Id": 11, + * "Name": "vtex.subscription.subscription", + * "IsRequired": false, + * "IsActive": true, + * "Domains": [ + * { + * "FieldName": "vtex.subscription.key.frequency", + * "MaxCaracters": "15", + * "DomainValues": "1 month" + * }, + * { + * "FieldName": "vtex.subscription.key.purchaseday", + * "MaxCaracters": "15", + * "DomainValues": "1,15,28" + * } + * ] + * }, + * { + * "Id": 12, + * "Name": "T-Shirt Customization", + * "IsRequired": false, + * "IsActive": true, + * "Domains": [ + * { + * "FieldName": "T-Shirt Name", + * "MaxCaracters": "15", + * "DomainValues": "[]" + * } + * ] + * } + * ] + * } * ``` */ "GET /api/catalog/pvt/attachments": { @@ -5560,22 +5559,22 @@ SpecificationFieldId?: number /** * >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L). * - * Retrieves general information of a Collection. - * - * ## Response body example - * - * ```json - * { - * "Id": 159, - * "Name": "Winter", - * "Description": null, - * "Searchable": false, - * "Highlight": false, - * "DateFrom": "2021-09-27T10:47:00", - * "DateTo": "2027-09-27T10:47:00", - * "TotalProducts": 0, - * "Type": "Manual" - * } + * Retrieves general information of a Collection. + * + * ## Response body example + * + * ```json + * { + * "Id": 159, + * "Name": "Winter", + * "Description": null, + * "Searchable": false, + * "Highlight": false, + * "DateFrom": "2021-09-27T10:47:00", + * "DateTo": "2027-09-27T10:47:00", + * "TotalProducts": 0, + * "Type": "Manual" + * } * ``` */ "GET /api/catalog/pvt/collection/:collectionId": { @@ -5621,33 +5620,33 @@ Type?: string /** * >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L). * - * Updates a previously created Collection. - * ## Request body example - * - * ```json - * { - * "Name": "Winter", - * "Searchable": false, - * "Highlight": false, - * "DateFrom": "2021-09-27T10:47:00", - * "DateTo": "2027-09-27T10:47:00" - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 159, - * "Name": "Winter", - * "Description": null, - * "Searchable": false, - * "Highlight": false, - * "DateFrom": "2021-09-27T10:47:00", - * "DateTo": "2027-09-27T10:47:00", - * "TotalProducts": 0, - * "Type": "Manual" - * } + * Updates a previously created Collection. + * ## Request body example + * + * ```json + * { + * "Name": "Winter", + * "Searchable": false, + * "Highlight": false, + * "DateFrom": "2021-09-27T10:47:00", + * "DateTo": "2027-09-27T10:47:00" + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 159, + * "Name": "Winter", + * "Description": null, + * "Searchable": false, + * "Highlight": false, + * "DateFrom": "2021-09-27T10:47:00", + * "DateTo": "2027-09-27T10:47:00", + * "TotalProducts": 0, + * "Type": "Manual" + * } * ``` */ "PUT /api/catalog/pvt/collection/:collectionId": { @@ -5723,33 +5722,33 @@ Type?: string /** * >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L). * - * Creates a new Collection. - * ## Request body example - * - * ```json - * { - * "Name": "Winter", - * "Searchable": false, - * "Highlight": false, - * "DateFrom": "2021-09-27T10:47:00", - * "DateTo": "2027-09-27T10:47:00" - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 159, - * "Name": "Winter", - * "Description": null, - * "Searchable": false, - * "Highlight": false, - * "DateFrom": "2021-09-27T10:47:00", - * "DateTo": "2027-09-27T10:47:00", - * "TotalProducts": 0, - * "Type": "Manual" - * } + * Creates a new Collection. + * ## Request body example + * + * ```json + * { + * "Name": "Winter", + * "Searchable": false, + * "Highlight": false, + * "DateFrom": "2021-09-27T10:47:00", + * "DateTo": "2027-09-27T10:47:00" + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 159, + * "Name": "Winter", + * "Description": null, + * "Searchable": false, + * "Highlight": false, + * "DateFrom": "2021-09-27T10:47:00", + * "DateTo": "2027-09-27T10:47:00", + * "TotalProducts": 0, + * "Type": "Manual" + * } * ``` */ "POST /api/catalog/pvt/collection": { @@ -5817,36 +5816,36 @@ Type?: string /** * >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L). * - * Retrieves all Subcollections given a Collection ID. A Subcollection is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection. - * ## Response body example - * - * ```json - * [ - * { - * "Id": 12, - * "CollectionId": 149, - * "Name": "Subcollection", - * "Type": "Inclusive", - * "PreSale": false, - * "Release": true - * }, - * { - * "Id": 13, - * "CollectionId": 149, - * "Name": "Test", - * "Type": "Exclusive", - * "PreSale": true, - * "Release": false - * }, - * { - * "Id": 14, - * "CollectionId": 149, - * "Name": "asdfghj", - * "Type": "Inclusive", - * "PreSale": false, - * "Release": false - * } - * ] + * Retrieves all Subcollections given a Collection ID. A Subcollection is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection. + * ## Response body example + * + * ```json + * [ + * { + * "Id": 12, + * "CollectionId": 149, + * "Name": "Subcollection", + * "Type": "Inclusive", + * "PreSale": false, + * "Release": true + * }, + * { + * "Id": 13, + * "CollectionId": 149, + * "Name": "Test", + * "Type": "Exclusive", + * "PreSale": true, + * "Release": false + * }, + * { + * "Id": 14, + * "CollectionId": 149, + * "Name": "asdfghj", + * "Type": "Inclusive", + * "PreSale": false, + * "Release": false + * } + * ] * ``` */ "GET /api/catalog/pvt/collection/:collectionId/subcollection": { @@ -5880,18 +5879,18 @@ Release?: boolean /** * >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L). * - * Retrieves information about a Subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection. - * ## Response body example - * - * ```json - * { - * "Id": 13, - * "CollectionId": 149, - * "Name": "Test", - * "Type": "Exclusive", - * "PreSale": true, - * "Release": false - * } + * Retrieves information about a Subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection. + * ## Response body example + * + * ```json + * { + * "Id": 13, + * "CollectionId": 149, + * "Name": "Test", + * "Type": "Exclusive", + * "PreSale": true, + * "Release": false + * } * ``` */ "GET /api/catalog/pvt/subcollection/:subCollectionId": { @@ -5925,18 +5924,18 @@ Release?: boolean /** * >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L). * - * Updates a previously created Subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection. - * - * ## Request or response body example - * - * ```json - * { - * "CollectionId": 149, - * "Name": "Test", - * "Type": "Exclusive", - * "PreSale": true, - * "Release": false - * } + * Updates a previously created Subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection. + * + * ## Request or response body example + * + * ```json + * { + * "CollectionId": 149, + * "Name": "Test", + * "Type": "Exclusive", + * "PreSale": true, + * "Release": false + * } * ``` */ "PUT /api/catalog/pvt/subcollection/:subCollectionId": { @@ -6000,29 +5999,29 @@ Release?: boolean /** * >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L). * - * Creates a new Subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection. A Subcollection can be either “Exclusive” (all the products contained in it will not be used) or “Inclusive” (all the products contained in it will be used). - * ## Request body example - * - * ```json - * { - * "CollectionId": 149, - * "Name": "Test", - * "Type": "Exclusive", - * "PreSale": true, - * "Release": false - * } - * ``` - * ## Response body example - * - * ```json - * { - * "Id": 13, - * "CollectionId": 149, - * "Name": "Test", - * "Type": "Exclusive", - * "PreSale": true, - * "Release": false - * } + * Creates a new Subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection. A Subcollection can be either “Exclusive” (all the products contained in it will not be used) or “Inclusive” (all the products contained in it will be used). + * ## Request body example + * + * ```json + * { + * "CollectionId": 149, + * "Name": "Test", + * "Type": "Exclusive", + * "PreSale": true, + * "Release": false + * } + * ``` + * ## Response body example + * + * ```json + * { + * "Id": 13, + * "CollectionId": 149, + * "Name": "Test", + * "Type": "Exclusive", + * "PreSale": true, + * "Release": false + * } * ``` */ "POST /api/catalog/pvt/subcollection": { @@ -6078,15 +6077,15 @@ Release?: boolean /** * >⚠️ There are two ways to configure collections, through Legacy CMS Portal or using the Beta Collection module. This endpoint is compatible with [collections configured through the Legacy CMS Portal](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L). * - * Edits the position of an SKU that already exists in the Subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection. - * ## Request body example - * - * ```json - * { - * "skuId": 1, - * "position": 1, - * "subCollectionId": 17 - * } + * Edits the position of an SKU that already exists in the Subcollection, which is a [Group](https://help.vtex.com/en/tutorial/adding-collections-cms--2YBy6P6X0NFRpkD2ZBxF6L#group-types) within a Collection. + * ## Request body example + * + * ```json + * { + * "skuId": 1, + * "position": 1, + * "subCollectionId": 17 + * } * ``` */ "POST /api/catalog/pvt/collection/:collectionId/position": { @@ -6106,29 +6105,29 @@ subCollectionId: number } } /** - * Retrieves information of a Product or SKU Specification. - * ## Response body example - * - * ```json - * { - * "Id": 88, - * "FieldTypeId": 1, - * "CategoryId": 4, - * "FieldGroupId": 20, - * "Name": "Material", - * "Description": "Composition of the product.", - * "Position": 1, - * "IsFilter": true, - * "IsRequired": true, - * "IsOnProductDetails": false, - * "IsStockKeepingUnit": false, - * "IsWizard": false, - * "IsActive": true, - * "IsTopMenuLinkActive": false, - * "IsSideMenuLinkActive": true, - * "DefaultValue": "Cotton" - * } - * ``` + * Retrieves information of a Product or SKU Specification. + * ## Response body example + * + * ```json + * { + * "Id": 88, + * "FieldTypeId": 1, + * "CategoryId": 4, + * "FieldGroupId": 20, + * "Name": "Material", + * "Description": "Composition of the product.", + * "Position": 1, + * "IsFilter": true, + * "IsRequired": true, + * "IsOnProductDetails": false, + * "IsStockKeepingUnit": false, + * "IsWizard": false, + * "IsActive": true, + * "IsTopMenuLinkActive": false, + * "IsSideMenuLinkActive": true, + * "DefaultValue": "Cotton" + * } + * ``` * */ "GET /api/catalog/pvt/specification/:specificationId": { @@ -6201,53 +6200,53 @@ DefaultValue: (null | string) } } /** - * Updates a Product Specification or SKU Specification. - * - * >⚠️ It is not possible to edit `FieldTypeId`, `CategoryId`, `FieldGroupId` or `IsStockKeepingUnit` in this API call. - * - * ## Request body example - * - * ```json - * { - * "FieldTypeId": 1, - * "CategoryId": 4, - * "FieldGroupId": 20, - * "Name": "Material", - * "Description": "Composition of the product.", - * "Position": 1, - * "IsFilter": true, - * "IsRequired": true, - * "IsOnProductDetails": false, - * "IsStockKeepingUnit": false, - * "IsActive": true, - * "IsTopMenuLinkActive": false, - * "IsSideMenuLinkActive": true, - * "DefaultValue": "Leather" - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 88, - * "FieldTypeId": 1, - * "CategoryId": 4, - * "FieldGroupId": 20, - * "Name": "Material", - * "Description": "Composition of the product.", - * "Position": 1, - * "IsFilter": true, - * "IsRequired": true, - * "IsOnProductDetails": false, - * "IsStockKeepingUnit": false, - * "IsWizard": false, - * "IsActive": true, - * "IsTopMenuLinkActive": false, - * "IsSideMenuLinkActive": true, - * "DefaultValue": "Leather" - * } - * ``` + * Updates a Product Specification or SKU Specification. + * + * >⚠️ It is not possible to edit `FieldTypeId`, `CategoryId`, `FieldGroupId` or `IsStockKeepingUnit` in this API call. + * + * ## Request body example + * + * ```json + * { + * "FieldTypeId": 1, + * "CategoryId": 4, + * "FieldGroupId": 20, + * "Name": "Material", + * "Description": "Composition of the product.", + * "Position": 1, + * "IsFilter": true, + * "IsRequired": true, + * "IsOnProductDetails": false, + * "IsStockKeepingUnit": false, + * "IsActive": true, + * "IsTopMenuLinkActive": false, + * "IsSideMenuLinkActive": true, + * "DefaultValue": "Leather" + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 88, + * "FieldTypeId": 1, + * "CategoryId": 4, + * "FieldGroupId": 20, + * "Name": "Material", + * "Description": "Composition of the product.", + * "Position": 1, + * "IsFilter": true, + * "IsRequired": true, + * "IsOnProductDetails": false, + * "IsStockKeepingUnit": false, + * "IsWizard": false, + * "IsActive": true, + * "IsTopMenuLinkActive": false, + * "IsSideMenuLinkActive": true, + * "DefaultValue": "Leather" + * } + * ``` * */ "PUT /api/catalog/pvt/specification/:specificationId": { @@ -6340,14 +6339,14 @@ Name?: string */ Description?: (null | string) /** - * Store Framework - Deprecated. - * Legacy CMS Portal - This position number is used in ordering the specifications both in the navigation menu and in the specification listing on the product page. + * Store Framework - Deprecated. + * Legacy CMS Portal - This position number is used in ordering the specifications both in the navigation menu and in the specification listing on the product page. * */ Position?: number /** - * Store Framework - Deprecated. - * Legacy CMS Portal - To allow the specification to be used as a facet (filter) on the search navigation bar. + * Store Framework - Deprecated. + * Legacy CMS Portal - To allow the specification to be used as a facet (filter) on the search navigation bar. * */ IsFilter?: boolean @@ -6356,8 +6355,8 @@ IsFilter?: boolean */ IsRequired?: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal -If specification is visible on the product page. + * Store Framework - Deprecated. + * Legacy CMS Portal -If specification is visible on the product page. * */ IsOnProductDetails?: boolean @@ -6374,14 +6373,14 @@ IsWizard?: (null | boolean) */ IsActive?: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal - To make the specification visible in the store's upper menu. + * Store Framework - Deprecated. + * Legacy CMS Portal - To make the specification visible in the store's upper menu. * */ IsTopMenuLinkActive?: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal - To make the specification field clickable in the search navigation bar. + * Store Framework - Deprecated. + * Legacy CMS Portal - To make the specification field clickable in the search navigation bar. * */ IsSideMenuLinkActive?: boolean @@ -6392,50 +6391,50 @@ DefaultValue?: string } } /** - * Creates a new Product or SKU Specification. - * ## Request body example - * - * ```json - * { - * "FieldTypeId": 1, - * "CategoryId": 4, - * "FieldGroupId": 20, - * "Name": "Material", - * "Description": "Composition of the product.", - * "Position": 1, - * "IsFilter": true, - * "IsRequired": true, - * "IsOnProductDetails": false, - * "IsStockKeepingUnit": false, - * "IsActive": true, - * "IsTopMenuLinkActive": false, - * "IsSideMenuLinkActive": true, - * "DefaultValue": "Cotton" - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 88, - * "FieldTypeId": 1, - * "CategoryId": 4, - * "FieldGroupId": 20, - * "Name": "Material", - * "Description": "Composition of the product.", - * "Position": 1, - * "IsFilter": true, - * "IsRequired": true, - * "IsOnProductDetails": false, - * "IsStockKeepingUnit": false, - * "IsWizard": false, - * "IsActive": true, - * "IsTopMenuLinkActive": false, - * "IsSideMenuLinkActive": true, - * "DefaultValue": "Cotton" - * } - * ``` + * Creates a new Product or SKU Specification. + * ## Request body example + * + * ```json + * { + * "FieldTypeId": 1, + * "CategoryId": 4, + * "FieldGroupId": 20, + * "Name": "Material", + * "Description": "Composition of the product.", + * "Position": 1, + * "IsFilter": true, + * "IsRequired": true, + * "IsOnProductDetails": false, + * "IsStockKeepingUnit": false, + * "IsActive": true, + * "IsTopMenuLinkActive": false, + * "IsSideMenuLinkActive": true, + * "DefaultValue": "Cotton" + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 88, + * "FieldTypeId": 1, + * "CategoryId": 4, + * "FieldGroupId": 20, + * "Name": "Material", + * "Description": "Composition of the product.", + * "Position": 1, + * "IsFilter": true, + * "IsRequired": true, + * "IsOnProductDetails": false, + * "IsStockKeepingUnit": false, + * "IsWizard": false, + * "IsActive": true, + * "IsTopMenuLinkActive": false, + * "IsSideMenuLinkActive": true, + * "DefaultValue": "Cotton" + * } + * ``` * */ "POST /api/catalog/pvt/specification": { @@ -6461,14 +6460,14 @@ Name: string */ Description?: (null | string) /** - * Store Framework - Deprecated. - * Legacy CMS Portal - This position number is used in ordering the specifications both in the navigation menu and in the specification listing on the product page. + * Store Framework - Deprecated. + * Legacy CMS Portal - This position number is used in ordering the specifications both in the navigation menu and in the specification listing on the product page. * */ Position?: number /** - * Store Framework - Deprecated. - * Legacy CMS Portal - To allow the specification to be used as a facet (filter) on the search navigation bar. + * Store Framework - Deprecated. + * Legacy CMS Portal - To allow the specification to be used as a facet (filter) on the search navigation bar. * */ IsFilter?: boolean @@ -6477,8 +6476,8 @@ IsFilter?: boolean */ IsRequired?: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal -If specification is visible on the product page. + * Store Framework - Deprecated. + * Legacy CMS Portal -If specification is visible on the product page. * */ IsOnProductDetails?: boolean @@ -6495,14 +6494,14 @@ IsWizard?: (null | boolean) */ IsActive?: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal - To make the specification visible in the store's upper menu. + * Store Framework - Deprecated. + * Legacy CMS Portal - To make the specification visible in the store's upper menu. * */ IsTopMenuLinkActive?: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal - To make the specification field clickable in the search navigation bar. + * Store Framework - Deprecated. + * Legacy CMS Portal - To make the specification field clickable in the search navigation bar. * */ IsSideMenuLinkActive?: boolean @@ -6537,14 +6536,14 @@ Name?: string */ Description?: (null | string) /** - * Store Framework - Deprecated. - * Legacy CMS Portal - This position number is used in ordering the specifications both in the navigation menu and in the specification listing on the product page. + * Store Framework - Deprecated. + * Legacy CMS Portal - This position number is used in ordering the specifications both in the navigation menu and in the specification listing on the product page. * */ Position?: number /** - * Store Framework - Deprecated. - * Legacy CMS Portal - To allow the specification to be used as a facet (filter) on the search navigation bar. + * Store Framework - Deprecated. + * Legacy CMS Portal - To allow the specification to be used as a facet (filter) on the search navigation bar. * */ IsFilter?: boolean @@ -6553,8 +6552,8 @@ IsFilter?: boolean */ IsRequired?: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal -If specification is visible on the product page. + * Store Framework - Deprecated. + * Legacy CMS Portal -If specification is visible on the product page. * */ IsOnProductDetails?: boolean @@ -6571,14 +6570,14 @@ IsWizard?: (null | boolean) */ IsActive?: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal - To make the specification visible in the store's upper menu. + * Store Framework - Deprecated. + * Legacy CMS Portal - To make the specification visible in the store's upper menu. * */ IsTopMenuLinkActive?: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal - To make the specification field clickable in the search navigation bar. + * Store Framework - Deprecated. + * Legacy CMS Portal - To make the specification field clickable in the search navigation bar. * */ IsSideMenuLinkActive?: boolean @@ -6589,35 +6588,35 @@ DefaultValue?: string } } /** - * Retrieves details from a specification field by this field's ID. - * >⚠️ This is a legacy endpoint. We recommend using [Get Specification](https://developers.vtex.com/vtex-rest-api/reference/get_api-catalog-pvt-specification-specificationid) instead. - * - * ## Response body example - * - * ```json - * { - * "Name": "Material", - * "CategoryId": 4, - * "FieldId": 88, - * "IsActive": true, - * "IsRequired": true, - * "FieldTypeId": 1, - * "FieldTypeName": "Texto", - * "FieldValueId": null, - * "Description": "Composition of the product.", - * "IsStockKeepingUnit": false, - * "IsFilter": true, - * "IsOnProductDetails": false, - * "Position": 1, - * "IsWizard": false, - * "IsTopMenuLinkActive": false, - * "IsSideMenuLinkActive": true, - * "DefaultValue": null, - * "FieldGroupId": 20, - * "FieldGroupName": "Clothes specifications" - * } - * ``` - * + * Retrieves details from a specification field by this field's ID. + * >⚠️ This is a legacy endpoint. We recommend using [Get Specification](https://developers.vtex.com/vtex-rest-api/reference/get_api-catalog-pvt-specification-specificationid) instead. + * + * ## Response body example + * + * ```json + * { + * "Name": "Material", + * "CategoryId": 4, + * "FieldId": 88, + * "IsActive": true, + * "IsRequired": true, + * "FieldTypeId": 1, + * "FieldTypeName": "Texto", + * "FieldValueId": null, + * "Description": "Composition of the product.", + * "IsStockKeepingUnit": false, + * "IsFilter": true, + * "IsOnProductDetails": false, + * "Position": 1, + * "IsWizard": false, + * "IsTopMenuLinkActive": false, + * "IsSideMenuLinkActive": true, + * "DefaultValue": null, + * "FieldGroupId": 20, + * "FieldGroupName": "Clothes specifications" + * } + * ``` + * * */ "GET /api/catalog_system/pub/specification/fieldGet/:fieldId": { @@ -6659,20 +6658,20 @@ Description?: (null | string) */ IsStockKeepingUnit?: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal - To allow the specification to be used as a facet (filter) on the search navigation bar. + * Store Framework - Deprecated. + * Legacy CMS Portal - To allow the specification to be used as a facet (filter) on the search navigation bar. * */ IsFilter?: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal -If specification is visible on the product page. + * Store Framework - Deprecated. + * Legacy CMS Portal -If specification is visible on the product page. * */ IsOnProductDetails?: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal - This position number is used in ordering the specifications both in the navigation menu and in the specification listing on the product page. + * Store Framework - Deprecated. + * Legacy CMS Portal - This position number is used in ordering the specifications both in the navigation menu and in the specification listing on the product page. * */ Position?: number @@ -6681,14 +6680,14 @@ Position?: number */ IsWizard?: (null | boolean) /** - * Store Framework - Deprecated. - * Legacy CMS Portal - To make the specification visible in the store's upper menu. + * Store Framework - Deprecated. + * Legacy CMS Portal - To make the specification visible in the store's upper menu. * */ IsTopMenuLinkActive?: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal - To make the specification field clickable in the search navigation bar. + * Store Framework - Deprecated. + * Legacy CMS Portal - To make the specification field clickable in the search navigation bar. * */ IsSideMenuLinkActive?: boolean @@ -6707,38 +6706,38 @@ FieldGroupName?: string } } /** - * Creates a specification field in a category. - * >⚠️ This is a legacy endpoint. We recommend using [Create Specification](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-post-specification) instead. - * - * ## Request body example - * - * ```json - * { - * "Name": "Material", - * "CategoryId": 4, - * "FieldId": 88, - * "IsActive": true, - * "IsRequired": true, - * "FieldTypeId": 1, - * "FieldValueId": 1, - * "IsStockKeepingUnit": false, - * "Description": "Composition of the product.", - * "IsFilter": true, - * "IsOnProductDetails": false, - * "Position": 1, - * "IsWizard": false, - * "IsTopMenuLinkActive": true, - * "IsSideMenuLinkActive": true, - * "DefaultValue": null, - * "FieldGroupId": 20, - * "FieldGroupName": "Clothes specifications" - * } - * ``` - * - * ## Response body example - * - * ```json - * 89 + * Creates a specification field in a category. + * >⚠️ This is a legacy endpoint. We recommend using [Create Specification](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-post-specification) instead. + * + * ## Request body example + * + * ```json + * { + * "Name": "Material", + * "CategoryId": 4, + * "FieldId": 88, + * "IsActive": true, + * "IsRequired": true, + * "FieldTypeId": 1, + * "FieldValueId": 1, + * "IsStockKeepingUnit": false, + * "Description": "Composition of the product.", + * "IsFilter": true, + * "IsOnProductDetails": false, + * "Position": 1, + * "IsWizard": false, + * "IsTopMenuLinkActive": true, + * "IsSideMenuLinkActive": true, + * "DefaultValue": null, + * "FieldGroupId": 20, + * "FieldGroupName": "Clothes specifications" + * } + * ``` + * + * ## Response body example + * + * ```json + * 89 * ``` */ "POST /api/catalog_system/pvt/specification/field": { @@ -6749,37 +6748,37 @@ body: SpecificationsInsertFieldRequest response: number } /** - * Updates a specification field in a category. - * >⚠️ This is a legacy endpoint. We recommend using [Update Specification](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-put-specification) instead. - * - * ## Request body example - * - * ```json - * { - * "FieldId": 89, - * "Name": "Material", - * "CategoryId": 4, - * "IsActive": true, - * "IsRequired": true, - * "FieldTypeId": 1, - * "Description": "Composition of the product.", - * "IsStockKeepingUnit": false, - * "IsFilter": true, - * "IsOnProductDetails": true, - * "Position": 1, - * "IsWizard": false, - * "IsTopMenuLinkActive": false, - * "IsSideMenuLinkActive": false, - * "DefaultValue": "Cotton", - * "FieldGroupId": 20, - * "FieldGroupName": "Clothes specifications" - * } - * ``` - * - * ## Response body example - * - * ```json - * 89 + * Updates a specification field in a category. + * >⚠️ This is a legacy endpoint. We recommend using [Update Specification](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-put-specification) instead. + * + * ## Request body example + * + * ```json + * { + * "FieldId": 89, + * "Name": "Material", + * "CategoryId": 4, + * "IsActive": true, + * "IsRequired": true, + * "FieldTypeId": 1, + * "Description": "Composition of the product.", + * "IsStockKeepingUnit": false, + * "IsFilter": true, + * "IsOnProductDetails": true, + * "Position": 1, + * "IsWizard": false, + * "IsTopMenuLinkActive": false, + * "IsSideMenuLinkActive": false, + * "DefaultValue": "Cotton", + * "FieldGroupId": 20, + * "FieldGroupName": "Clothes specifications" + * } + * ``` + * + * ## Response body example + * + * ```json + * 89 * ``` */ "PUT /api/catalog_system/pvt/specification/field": { @@ -6790,20 +6789,20 @@ body: SpecificationsInsertFieldUpdateRequest response: number } /** - * Retrieves details from a specification field's value by this value's ID. - * >⚠️ This is a legacy endpoint. We recommend using [Get Specification Value](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-specification-value-id) instead. - * - * ## Response body example - * - * ```json - * { - * "FieldValueId": 143, - * "FieldId": 34, - * "Name": "TesteInsert", - * "Text": "Value Description", - * "IsActive": true, - * "Position": 100 - * } + * Retrieves details from a specification field's value by this value's ID. + * >⚠️ This is a legacy endpoint. We recommend using [Get Specification Value](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-specification-value-id) instead. + * + * ## Response body example + * + * ```json + * { + * "FieldValueId": 143, + * "FieldId": 34, + * "Name": "TesteInsert", + * "Text": "Value Description", + * "IsActive": true, + * "Position": 100 + * } * ``` */ "GET /api/catalog_system/pvt/specification/fieldValue/:fieldValueId": { @@ -6835,88 +6834,88 @@ Position?: number } } /** - * Gets a list of all specification values from a Specification Field by this field's ID. - * - * ## Response body example - * - * ```json - * [ - * { - * "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 - * } - * ] + * Gets a list of all specification values from a Specification Field by this field's ID. + * + * ## Response body example + * + * ```json + * [ + * { + * "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 + * } + * ] * ``` */ "GET /api/catalog_system/pub/specification/fieldvalue/:fieldId": { response: GetSpecFieldValue[] } /** - * Creates a specification field value by the specification field's ID. - * >⚠️ This is a legacy endpoint. We recommend using [Create Specification Value](https://developers.vtex.com/docs/api-reference/catalog-api#post-/api/catalog/pvt/specificationvalue) instead. - * - * - * ## Request body example - * - * ```json - * { - * "FieldId": 34, - * "Name": "Cotton", - * "Text": "Cotton fibers", - * "IsActive": true, - * "Position": 100 - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "FieldValueId": 143, - * "FieldId": 34, - * "Name": "Cotton", - * "Text": "Cotton fibers", - * "IsActive": true, - * "Position": 100 - * } + * Creates a specification field value by the specification field's ID. + * >⚠️ This is a legacy endpoint. We recommend using [Create Specification Value](https://developers.vtex.com/docs/api-reference/catalog-api#post-/api/catalog/pvt/specificationvalue) instead. + * + * + * ## Request body example + * + * ```json + * { + * "FieldId": 34, + * "Name": "Cotton", + * "Text": "Cotton fibers", + * "IsActive": true, + * "Position": 100 + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "FieldValueId": 143, + * "FieldId": 34, + * "Name": "Cotton", + * "Text": "Cotton fibers", + * "IsActive": true, + * "Position": 100 + * } * ``` */ "POST /api/catalog_system/pvt/specification/fieldValue": { @@ -6949,27 +6948,27 @@ Position?: number } } /** - * Updates a specification field value by the specification field's ID. - * >⚠️ This is a legacy endpoint. We recommend using [Update Specification Field Value](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-put-specification-value-id) instead. - * - * - * ## Request body example - * - * ```json - * { - * "FieldId": 1, - * "FieldValueId": 143, - * "Name": "Cotton", - * "Text": "Cotton fibers", - * "IsActive": true, - * "Position": 100 - * } - * ``` - * - * ## Response body example (200 OK) - * - * ```json - * "Field Value Updated" + * Updates a specification field value by the specification field's ID. + * >⚠️ This is a legacy endpoint. We recommend using [Update Specification Field Value](https://developers.vtex.com/vtex-rest-api/reference/catalog-api-put-specification-value-id) instead. + * + * + * ## Request body example + * + * ```json + * { + * "FieldId": 1, + * "FieldValueId": 143, + * "Name": "Cotton", + * "Text": "Cotton fibers", + * "IsActive": true, + * "Position": 100 + * } + * ``` + * + * ## Response body example (200 OK) + * + * ```json + * "Field Value Updated" * ``` */ "PUT /api/catalog_system/pvt/specification/fieldValue": { @@ -6980,18 +6979,18 @@ body: SpecificationsUpdateFieldValueRequest response: string } /** - * Retrieves general information about a Specification Value. - * ## Response body example - * - * ```json - * { - * "FieldValueId": 143, - * "FieldId": 34, - * "Name": "Cotton", - * "Text": "Cotton fibers", - * "IsActive": true, - * "Position": 100 - * } + * Retrieves general information about a Specification Value. + * ## Response body example + * + * ```json + * { + * "FieldValueId": 143, + * "FieldId": 34, + * "Name": "Cotton", + * "Text": "Cotton fibers", + * "IsActive": true, + * "Position": 100 + * } * ``` */ "GET /api/catalog/pvt/specificationvalue/:specificationValueId": { @@ -7023,30 +7022,30 @@ Position?: number } } /** - * Updates a new Specification Value for a Category. - * ## Request body example - * - * ```json - * { - * "FieldId": 193, - * "Name": "Metal", - * "Text": null, - * "IsActive": true, - * "Position": 1 - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "FieldValueId": 360, - * "FieldId": 193, - * "Name": "Metal", - * "Text": null, - * "IsActive": true, - * "Position": 1 - * } + * Updates a new Specification Value for a Category. + * ## Request body example + * + * ```json + * { + * "FieldId": 193, + * "Name": "Metal", + * "Text": null, + * "IsActive": true, + * "Position": 1 + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "FieldValueId": 360, + * "FieldId": 193, + * "Name": "Metal", + * "Text": null, + * "IsActive": true, + * "Position": 1 + * } * ``` */ "PUT /api/catalog/pvt/specificationvalue/:specificationValueId": { @@ -7102,29 +7101,29 @@ Position?: number } } /** - * Creates a new Specification Value for a Category. - * ## Request body example - * - * ```json - * { - * "FieldId": 193, - * "Name": "Metal", - * "IsActive": true, - * "Position": 1 - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "FieldValueId": 360, - * "FieldId": 193, - * "Name": "Metal", - * "Text": null, - * "IsActive": true, - * "Position": 1 - * } + * Creates a new Specification Value for a Category. + * ## Request body example + * + * ```json + * { + * "FieldId": 193, + * "Name": "Metal", + * "IsActive": true, + * "Position": 1 + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "FieldValueId": 360, + * "FieldId": 193, + * "Name": "Metal", + * "Text": null, + * "IsActive": true, + * "Position": 1 + * } * ``` */ "POST /api/catalog/pvt/specificationvalue": { @@ -7180,66 +7179,66 @@ Position?: number } } /** - * Retrieves a list of specification groups by the category ID. - * ## Response body example - * - * ```json - * [ - * { - * "CategoryId": 1, - * "Id": 5, - * "Name": "Materials", - * "Position": 2 - * }, - * { - * "CategoryId": 1, - * "Id": 6, - * "Name": "Sizes", - * "Position": 3 - * } - * ] + * Retrieves a list of specification groups by the category ID. + * ## Response body example + * + * ```json + * [ + * { + * "CategoryId": 1, + * "Id": 5, + * "Name": "Materials", + * "Position": 2 + * }, + * { + * "CategoryId": 1, + * "Id": 6, + * "Name": "Sizes", + * "Position": 3 + * } + * ] * ``` */ "GET /api/catalog_system/pvt/specification/groupbycategory/:categoryId": { response: SpecificationsGroup[] } /** - * Retrieves details from a specification group by the ID of the group. - * ## Response body example - * - * ```json - * { - * "CategoryId": 1, - * "Id": 6, - * "Name": "Sizes", - * "Position": 3 - * } + * Retrieves details from a specification group by the ID of the group. + * ## Response body example + * + * ```json + * { + * "CategoryId": 1, + * "Id": 6, + * "Name": "Sizes", + * "Position": 3 + * } * ``` */ "GET /api/catalog_system/pub/specification/groupGet/:groupId": { response: SpecificationsGroup } /** - * Create a specification group. - * >⚠️ It is also possible to create a Specification Group by using an alternative legacy route: `/api/catalog_system/pvt/specification/group`. - * ## Request body example - * - * ```json - * { - * "CategoryId": 1, - * "Name": "Sizes" - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 6, - * "CategoryId": 1, - * "Name": "Sizes", - * "Position": 3 - * } + * Create a specification group. + * >⚠️ It is also possible to create a Specification Group by using an alternative legacy route: `/api/catalog_system/pvt/specification/group`. + * ## Request body example + * + * ```json + * { + * "CategoryId": 1, + * "Name": "Sizes" + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 6, + * "CategoryId": 1, + * "Name": "Sizes", + * "Position": 3 + * } * ``` */ "POST /api/catalog/pvt/specificationgroup": { @@ -7258,25 +7257,25 @@ CategoryId?: number */ Name?: string /** - * Store Framework - Deprecated. + * Store Framework - Deprecated. * Legacy CMS Portal - Specification Group Position. */ Position?: number } } /** - * Update a specification group. - * >⚠️ It is also possible to update a Specification Group by using an alternative legacy route: `/api/catalog_system/pvt/specification/group`. - * - * ## Request and response body example - * - * ```json - * { - * "CategoryId": 1, - * "Id": 17, - * "Name": "NewGroupName", - * "Position": 1 - * } + * Update a specification group. + * >⚠️ It is also possible to update a Specification Group by using an alternative legacy route: `/api/catalog_system/pvt/specification/group`. + * + * ## Request and response body example + * + * ```json + * { + * "CategoryId": 1, + * "Id": 17, + * "Name": "NewGroupName", + * "Position": 1 + * } * ``` */ "PUT /api/catalog/pvt/specificationgroup/:groupId": { @@ -7318,16 +7317,16 @@ Position?: number } } /** - * Retrieves general information about unmapped Specifications of a Seller's SKU in a Marketplace. - * ## Response body example - * - * ```json - * { - * "Id": 1010, - * "SkuId": 310119072, - * "SpecificationName": "size", - * "SpecificationValue": "Small" - * } + * Retrieves general information about unmapped Specifications of a Seller's SKU in a Marketplace. + * ## Response body example + * + * ```json + * { + * "Id": 1010, + * "SkuId": 310119072, + * "SpecificationName": "size", + * "SpecificationValue": "Small" + * } * ``` */ "GET /api/catalog/pvt/specification/nonstructured/:id": { @@ -7357,18 +7356,18 @@ SpecificationValue?: string } /** - * Gets general information about unmapped Specifications of a Seller's SKU in a Marketplace by SKU ID. - * ## Response body example - * - * ```json - * [ - * { - * "Id": 1010, - * "SkuId": 310119072, - * "SpecificationName": "size", - * "SpecificationValue": "Small" - * } - * ] + * Gets general information about unmapped Specifications of a Seller's SKU in a Marketplace by SKU ID. + * ## Response body example + * + * ```json + * [ + * { + * "Id": 1010, + * "SkuId": 310119072, + * "SpecificationName": "size", + * "SpecificationValue": "Small" + * } + * ] * ``` */ "GET /api/catalog/pvt/specification/nonstructured": { @@ -7409,35 +7408,35 @@ skuId: number } } /** - * Retrieves a list with details about the store's sales channels. - * ## Response body example - * - * ```json - * [ - * { - * "Id": 1, - * "Name": "Loja Principal", - * "IsActive": true, - * "ProductClusterId": null, - * "CountryCode": "BRA", - * "CultureInfo": "pt-BR", - * "TimeZone": "E. South America Standard Time", - * "CurrencyCode": "BRL", - * "CurrencySymbol": "R$", - * "CurrencyLocale": 1046, - * "CurrencyFormatInfo": { - * "CurrencyDecimalDigits": 1, - * "CurrencyDecimalSeparator": ",", - * "CurrencyGroupSeparator": ".", - * "CurrencyGroupSize": 3, - * "StartsWithCurrencySymbol": true - * }, - * "Origin": null, - * "Position": 2, - * "ConditionRule": null, - * "CurrencyDecimalDigits": 1 - * } - * ] + * Retrieves a list with details about the store's sales channels. + * ## Response body example + * + * ```json + * [ + * { + * "Id": 1, + * "Name": "Loja Principal", + * "IsActive": true, + * "ProductClusterId": null, + * "CountryCode": "BRA", + * "CultureInfo": "pt-BR", + * "TimeZone": "E. South America Standard Time", + * "CurrencyCode": "BRL", + * "CurrencySymbol": "R$", + * "CurrencyLocale": 1046, + * "CurrencyFormatInfo": { + * "CurrencyDecimalDigits": 1, + * "CurrencyDecimalSeparator": ",", + * "CurrencyGroupSeparator": ".", + * "CurrencyGroupSize": 3, + * "StartsWithCurrencySymbol": true + * }, + * "Origin": null, + * "Position": 2, + * "ConditionRule": null, + * "CurrencyDecimalDigits": 1 + * } + * ] * ``` */ "GET /api/catalog_system/pvt/saleschannel/list": { @@ -7526,34 +7525,34 @@ CurrencyDecimalDigits?: number }[] } /** - * Retrieves a specific sales channel by its ID. - * - * ## Response body example - * - * ```json - * { - * "Id": 1, - * "Name": "Loja Principal", - * "IsActive": true, - * "ProductClusterId": null, - * "CountryCode": "BRA", - * "CultureInfo": "pt-BR", - * "TimeZone": "E. South America Standard Time", - * "CurrencyCode": "BRL", - * "CurrencySymbol": "R$", - * "CurrencyLocale": 1046, - * "CurrencyFormatInfo": { - * "CurrencyDecimalDigits": 1, - * "CurrencyDecimalSeparator": ",", - * "CurrencyGroupSeparator": ".", - * "CurrencyGroupSize": 3, - * "StartsWithCurrencySymbol": true - * }, - * "Origin": null, - * "Position": 2, - * "ConditionRule": null, - * "CurrencyDecimalDigits": 1 - * } + * Retrieves a specific sales channel by its ID. + * + * ## Response body example + * + * ```json + * { + * "Id": 1, + * "Name": "Loja Principal", + * "IsActive": true, + * "ProductClusterId": null, + * "CountryCode": "BRA", + * "CultureInfo": "pt-BR", + * "TimeZone": "E. South America Standard Time", + * "CurrencyCode": "BRL", + * "CurrencySymbol": "R$", + * "CurrencyLocale": 1046, + * "CurrencyFormatInfo": { + * "CurrencyDecimalDigits": 1, + * "CurrencyDecimalSeparator": ",", + * "CurrencyGroupSeparator": ".", + * "CurrencyGroupSize": 3, + * "StartsWithCurrencySymbol": true + * }, + * "Origin": null, + * "Position": 2, + * "ConditionRule": null, + * "CurrencyDecimalDigits": 1 + * } * ``` */ "GET /api/catalog_system/pub/saleschannel/:salesChannelId": { @@ -8199,38 +8198,38 @@ TrustPolicy?: string } } /** - * Creates a new Supplier. - * ## Request body example - * - * ```json - * { - * "Name": "Supplier", - * "CorporateName": "TopStore", - * "StateInscription": "", - * "Cnpj": "33304981001272", - * "Phone": "3333333333", - * "CellPhone": "4444444444", - * "CorportePhone": "5555555555", - * "Email": "email@email.com", - * "IsActive": true - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 1, - * "Name": "Supplier", - * "CorporateName": "TopStore", - * "StateInscription": "", - * "Cnpj": "33304981001272", - * "Phone": "3333333333", - * "CellPhone": "4444444444", - * "CorportePhone": "5555555555", - * "Email": "email@email.com", - * "IsActive": true - * } + * Creates a new Supplier. + * ## Request body example + * + * ```json + * { + * "Name": "Supplier", + * "CorporateName": "TopStore", + * "StateInscription": "", + * "Cnpj": "33304981001272", + * "Phone": "3333333333", + * "CellPhone": "4444444444", + * "CorportePhone": "5555555555", + * "Email": "email@email.com", + * "IsActive": true + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 1, + * "Name": "Supplier", + * "CorporateName": "TopStore", + * "StateInscription": "", + * "Cnpj": "33304981001272", + * "Phone": "3333333333", + * "CellPhone": "4444444444", + * "CorportePhone": "5555555555", + * "Email": "email@email.com", + * "IsActive": true + * } * ``` */ "POST /api/catalog/pvt/supplier": { @@ -8238,38 +8237,38 @@ body: SupplierRequest response: SupplierResponse } /** - * Updates general information of an existing Supplier. - * ## Request body example - * - * ```json - * { - * "Name": "Supplier", - * "CorporateName": "TopStore", - * "StateInscription": "", - * "Cnpj": "33304981001272", - * "Phone": "3333333333", - * "CellPhone": "4444444444", - * "CorportePhone": "5555555555", - * "Email": "email@email.com", - * "IsActive": true - * } - * ``` - * - * ## Response body example - * - * ```json - * { - * "Id": 1, - * "Name": "Supplier", - * "CorporateName": "TopStore", - * "StateInscription": "", - * "Cnpj": "33304981001272", - * "Phone": "3333333333", - * "CellPhone": "4444444444", - * "CorportePhone": "5555555555", - * "Email": "email@email.com", - * "IsActive": true - * } + * Updates general information of an existing Supplier. + * ## Request body example + * + * ```json + * { + * "Name": "Supplier", + * "CorporateName": "TopStore", + * "StateInscription": "", + * "Cnpj": "33304981001272", + * "Phone": "3333333333", + * "CellPhone": "4444444444", + * "CorportePhone": "5555555555", + * "Email": "email@email.com", + * "IsActive": true + * } + * ``` + * + * ## Response body example + * + * ```json + * { + * "Id": 1, + * "Name": "Supplier", + * "CorporateName": "TopStore", + * "StateInscription": "", + * "Cnpj": "33304981001272", + * "Phone": "3333333333", + * "CellPhone": "4444444444", + * "CorportePhone": "5555555555", + * "Email": "email@email.com", + * "IsActive": true + * } * ``` */ "PUT /api/catalog/pvt/supplier/:supplierId": { @@ -8283,28 +8282,28 @@ response: SupplierResponse } /** - * Retrieves a list of Trade Policies associated to a Product based on the Product's ID. - * ## Response body example - * - * ```json - * [ - * { - * "ProductId": 1, - * "StoreId": 1 - * }, - * { - * "ProductId": 1, - * "StoreId": 2 - * }, - * { - * "ProductId": 1, - * "StoreId": 3 - * }, - * { - * "ProductId": 1, - * "StoreId": 4 - * } - * ] + * Retrieves a list of Trade Policies associated to a Product based on the Product's ID. + * ## Response body example + * + * ```json + * [ + * { + * "ProductId": 1, + * "StoreId": 1 + * }, + * { + * "ProductId": 1, + * "StoreId": 2 + * }, + * { + * "ProductId": 1, + * "StoreId": 3 + * }, + * { + * "ProductId": 1, + * "StoreId": 4 + * } + * ] * ``` */ "GET /api/catalog/pvt/product/:productId/salespolicy": { @@ -8332,34 +8331,34 @@ StoreId?: number } /** - * Retrieves a list of SKU IDs of a Trade Policy. - * ## Response body example - * - * ```json - * [ - * 405380, - * 405381, - * 405382, - * 405383, - * 405384, - * 405385, - * 405386, - * 405387, - * 405388, - * 405389, - * 405390, - * 405391, - * 405392, - * 405393, - * 405394, - * 405395, - * 405396, - * 405397, - * 405398, - * 405399, - * 405400, - * 405556 - * ] + * Retrieves a list of SKU IDs of a Trade Policy. + * ## Response body example + * + * ```json + * [ + * 405380, + * 405381, + * 405382, + * 405383, + * 405384, + * 405385, + * 405386, + * 405387, + * 405388, + * 405389, + * 405390, + * 405391, + * 405392, + * 405393, + * 405394, + * 405395, + * 405396, + * 405397, + * 405398, + * 405399, + * 405400, + * 405556 + * ] * ``` */ "GET /api/catalog_system/pvt/sku/stockkeepingunitidsbysaleschannel": { @@ -8387,55 +8386,55 @@ onlyAssigned?: boolean response: number[] } /** - * Retrieve details of a Product's Indexed Information in XML format. - * ## Response body example - * - * ```xml - * " - * \n - * \n - * - * true - * 0 - * 2 - * - * * - * - * instanceId:394dbdc8-b1f4-4dea-adfa-1ec104f3bfe1 - * productId:1 - * - * - * - * - * - * - * - * - * - * \n - * \n" + * Retrieve details of a Product's Indexed Information in XML format. + * ## Response body example + * + * ```xml + * " + * \n + * \n + * + * true + * 0 + * 2 + * + * * + * + * instanceId:394dbdc8-b1f4-4dea-adfa-1ec104f3bfe1 + * productId:1 + * + * + * + * + * + * + * + * + * + * \n + * \n" * ``` */ "GET /api/catalog_system/pvt/products/GetIndexedInfo/:productId": { } /** - * Lists all commercial conditions on the store. - * ## Response body example - * - * ```json - * [ - * { - * "Id": 1, - * "Name": "Padrão", - * "IsDefault": true - * }, - * { - * "Id": 2, - * "Name": "Teste Fast", - * "IsDefault": false - * } - * ] + * Lists all commercial conditions on the store. + * ## Response body example + * + * ```json + * [ + * { + * "Id": 1, + * "Name": "Padrão", + * "IsDefault": true + * }, + * { + * "Id": 2, + * "Name": "Teste Fast", + * "IsDefault": false + * } + * ] * ``` */ "GET /api/catalog_system/pvt/commercialcondition/list": { @@ -8455,15 +8454,15 @@ IsDefault?: boolean }[] } /** - * Retrieves information of a commercial condition by its ID. - * ## Response body example - * - * ```json - * { - * "Id": 1, - * "Name": "Padrão", - * "IsDefault": true - * } + * Retrieves information of a commercial condition by its ID. + * ## Response body example + * + * ```json + * { + * "Id": 1, + * "Name": "Padrão", + * "IsDefault": true + * } * ``` */ "GET /api/catalog_system/pvt/commercialcondition/:commercialConditionId": { @@ -8657,23 +8656,22 @@ fileUrl?: (null | string) } } /** - * This endpoint is used to simulate a cart in VTEX Checkout. - * - * It receives an **SKU ID**, the **quantity** of items in the cart and the ID of the **Seller**. - * - * It sends back all information about the cart, such as the selling price of each item, rates and benefits data, payment and logistics info. - * - * This is useful whenever you need to know the availability of fulfilling an order for a specific cart setting, since the API response will let you know the updated price, inventory and shipping data. - * + * This endpoint is used to simulate a cart in VTEX Checkout. + * + * It receives an **SKU ID**, the **quantity** of items in the cart and the ID of the **Seller**. + * + * It sends back all information about the cart, such as the selling price of each item, rates and benefits data, payment and logistics info. + * + * This is useful whenever you need to know the availability of fulfilling an order for a specific cart setting, since the API response will let you know the updated price, inventory and shipping data. + * * **Important**: The fields (`sku id`, `quantity`, `seller`, `country`, `postalCode` and `geoCoordinates`) are just examples of content that you can simulate in your cart. You can add more fields to the request as per your need. Access the [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) guide to check the available fields. */ "POST /api/checkout/pub/orderForms/simulation": { searchParams: { /** * This parameter defines which promotions apply to the simulation. Use `0` for simulations at cart stage, which means all promotions apply. In case of window simulation use `1`, which indicates promotions that apply nominal discounts over the total purchase value shouldn't be considered on the simulation. - * - * -Note that if this not sent, the parameter is `1`. + * + * Note that if this not sent, the parameter is `1`. */ RnbBehavior?: number /** @@ -9417,14 +9415,13 @@ assemblyOptions?: any[] } } /** - * You can use this request to get your current shopping cart information (`orderFormId`) or to create a new cart. - * - * **Important**: To create a new empty shopping cart you need to send this request with the query param `forceNewCart=true`. - * + * You can use this request to get your current shopping cart information (`orderFormId`) or to create a new cart. + * + * **Important**: To create a new empty shopping cart you need to send this request with the query param `forceNewCart=true`. + * * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` obtained in response is the identification code of the newly created cart. - * - * -> This request has a time out of 45 seconds. + * + * > This request has a time out of 45 seconds. */ "GET /api/checkout/pub/orderForm": { searchParams: { @@ -9435,12 +9432,11 @@ forceNewCart?: boolean } } /** - * Use this request to get all information associated to a given shopping cart. - * + * Use this request to get all information associated to a given shopping cart. + * * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. - * - * -> This request has a time out of 45 seconds. + * + * > This request has a time out of 45 seconds. */ "GET /api/checkout/pub/orderForm/:orderFormId": { searchParams: { @@ -9451,12 +9447,12 @@ refreshOutdatedData?: boolean } } /** - * This request removes all items from a given cart, leaving it empty. - * - * You must send an empty JSON in the body of the request. - * - * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. - * + * This request removes all items from a given cart, leaving it empty. + * + * You must send an empty JSON in the body of the request. + * + * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. + * * **Important**: **Request Body** must always be sent with empty value "{ }" in this endpoint. */ "POST /api/checkout/pub/orderForm/:orderFormId/items/removeAll": { @@ -9471,10 +9467,10 @@ response: { } } /** - * This call removes all user information, making a cart anonymous while leaving the items. - * - * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure that represents a shopping cart and contains all information about it. Hence, the `orderFormId` is the identification code of a given cart. - * + * This call removes all user information, making a cart anonymous while leaving the items. + * + * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure that represents a shopping cart and contains all information about it. Hence, the `orderFormId` is the identification code of a given cart. + * * This call works by creating a new orderForm, setting a new cookie, and returning a redirect 302 to the cart URL (`/checkout/#/orderform`). */ "GET /checkout/changeToAnonymousUser/:orderFormId": { @@ -9482,26 +9478,22 @@ response: { } /** * You can use this request to: - * - * -1. Change the quantity of one or more items in a specific cart. - * -2. Remove an item from the cart (by sending the `quantity` value = `0` in the request body). - * - * **Important**: To remove all items from the cart at the same time, use the [Remove all items](https://developers.vtex.com/vtex-rest-api/reference/removeallitems) endpoint. - * + * + * 1. Change the quantity of one or more items in a specific cart. + * 2. Remove an item from the cart (by sending the `quantity` value = `0` in the request body). + * + * **Important**: To remove all items from the cart at the same time, use the [Remove all items](https://developers.vtex.com/vtex-rest-api/reference/removeallitems) endpoint. + * * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure that represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. - * - * -> This request has a time out of 45 seconds. + * + * > This request has a time out of 45 seconds. */ "POST /api/checkout/pub/orderForm/:orderFormId/items/update": { searchParams: { /** * 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. - * - * -This array accepts strings and currently the only possible value is `”paymentData”`. + * + * This array accepts strings and currently the only possible value is `”paymentData”`. */ allowedOutdatedData?: any[] } @@ -10604,20 +10596,18 @@ ascending?: boolean } } /** - * Use this request to add a new item to the shopping cart. - * + * Use this request to add a new item to the shopping cart. + * * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. - * - * -> This request has a time out of 45 seconds. + * + * > This request has a time out of 45 seconds. */ "POST /api/checkout/pub/orderForm/:orderFormId/items": { searchParams: { /** * 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. - * - * -This array accepts strings and currently the only possible value is `”paymentData”`. + * + * This array accepts strings and currently the only possible value is `”paymentData”`. */ allowedOutdatedData?: any[] } @@ -11733,18 +11723,15 @@ ascending?: boolean } /** * You can use this request to: - * - * -1. Change the quantity or price of one or more items to the shopping cart. - * -2. Add a new item to the shopping cart. - * - * **Important**: To add a new item to the shopping cart, do not send the string `index` in the request body. - * + * + * 1. Change the quantity or price of one or more items to the shopping cart. + * 2. Add a new item to the shopping cart. + * + * **Important**: To add a new item to the shopping cart, do not send the string `index` in the request body. + * * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure that represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. - * - * -> This request has a time out of 45 seconds. + * + * > This request has a time out of 45 seconds. */ "PATCH /api/checkout/pub/orderForm/:orderFormId/items": { body: { @@ -12881,30 +12868,26 @@ ascending?: boolean } } /** - * This request changes the price of an SKU in a cart. - * + * This request changes the price of an SKU in a cart. + * * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. - * - * -You need to inform which cart you are referring to, by sending its `orderFormId` and what is the item whose price you want to change, by sending its `itemIndex`. - * - * -You also need to pass the new price value in the body. - * - * -Remember 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/docs/api-reference/checkout-api#get-/api/checkout/pvt/configuration/orderForm) endpoint. To make it active, use the [Update orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pvt/configuration/orderForm) endpoint, making the `allowManualPrice` field `true`. - * - * -> 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. + * + * You need to inform which cart you are referring to, by sending its `orderFormId` and what is the item whose price you want to change, by sending its `itemIndex`. + * + * You also need to pass the new price value in the body. + * + * Remember 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/docs/api-reference/checkout-api#get-/api/checkout/pvt/configuration/orderForm) endpoint. To make it active, use the [Update orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pvt/configuration/orderForm) endpoint, making the `allowManualPrice` field `true`. + * + * > 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. */ "PUT /api/checkout/pub/orderForm/:orderFormId/items/:itemIndex/price": { body: PriceChangeRequest } /** - * 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. - * - * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. - * + * 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. + * + * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. + * * Note 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. */ "PATCH /api/checkout/pub/orderForm/:orderFormId/profile": { @@ -12917,15 +12900,12 @@ ignoreProfileData?: boolean } /** * Retrieve a client's profile information by providing an email address. - * - * -If the response body fields are empty, the following situations may have occurred: - * - * -1. There is no client registered with the email address provided in your store, or; - * -2. Client profile is invalid or incomplete. However, you can use the query parameter `ensureComplete=false` to get incomplete profiles. For more information, see [SmartCheckout - Customer information automatic fill-in](https://help.vtex.com/en/tutorial/smartcheckout-customer-information-automatic-fill-in--2Nuu3xAFzdhIzJIldAdtan). - * + * + * If the response body fields are empty, the following situations may have occurred: + * + * 1. There is no client registered with the email address provided in your store, or; + * 2. Client profile is invalid or incomplete. However, you can use the query parameter `ensureComplete=false` to get incomplete profiles. For more information, see [SmartCheckout - Customer information automatic fill-in](https://help.vtex.com/en/tutorial/smartcheckout-customer-information-automatic-fill-in--2Nuu3xAFzdhIzJIldAdtan). + * * >⚠️ The authentication of this endpoint can change depending on the customer context. If you are consulting information from a customer with a complete profile on the store, the response will return the customer's data masked. You can only access the customer data with an authenticated request. */ "GET /api/checkout/pub/profiles": { @@ -13081,13 +13061,12 @@ isComplete?: boolean } } /** - * Use this request to include client profile information to a given shopping cart. - * + * Use this request to include client profile information to a given shopping cart. + * * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. - * - * -> This request has a time out of 12 seconds. - * + * + * > This request has a time out of 12 seconds. + * * >⚠️ The authentication of this endpoint can change depending on the customer context. If you are modifying information from a customer with a complete profile on the store, the response will return the customer's data masked. You can only access the customer data with an authenticated request. */ "POST /api/checkout/pub/orderForm/:orderFormId/attachments/clientProfileData": { @@ -13146,15 +13125,14 @@ isCorporate?: boolean } } /** - * Use this request to include shipping information and/or selected delivery option to a given shopping cart. - * - * To add shipping addresses send the `selectedAddresses` array. For delivery option use the `logisticsInfo` array. - * + * Use this request to include shipping information and/or selected delivery option to a given shopping cart. + * + * To add shipping addresses send the `selectedAddresses` array. For delivery option use the `logisticsInfo` array. + * * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. - * - * -> This request has a time out of 12 seconds. - * + * + * > This request has a time out of 12 seconds. + * * >⚠️ The authentication of this endpoint can change depending on the customer context. If you are modifying information from a customer with a complete profile on the store, the response will return the customer's data masked. You can only access the customer data with an authenticated request. */ "POST /api/checkout/pub/orderForm/:orderFormId/attachments/shippingData": { @@ -14296,12 +14274,11 @@ itemsOrdination?: (null | { } } /** - * Use this request to include client preferences information to a given shopping cart. - * + * Use this request to include client preferences information to a given shopping cart. + * * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. - * - * -> This request has a time out of 12 seconds. + * + * > This request has a time out of 12 seconds. */ "POST /api/checkout/pub/orderForm/:orderFormId/attachments/clientPreferencesData": { body: { @@ -14317,20 +14294,18 @@ optinNewsLetter?: boolean response: any } /** - * Use this request to include marketing information to a given shopping cart. - * + * Use this request to include marketing information to a given shopping cart. + * * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. - * - * -> This request has a time out of 12 seconds. + * + * > This request has a time out of 12 seconds. */ "POST /api/checkout/pub/orderForm/:orderFormId/attachments/marketingData": { body: { /** * 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. - * - * -To send more than one coupon code to the same cart, use commas. E.g.`"sales25, blackfriday30"`. + * + * To send more than one coupon code to the same cart, use commas. E.g.`"sales25, blackfriday30"`. */ coupon?: string /** @@ -14364,12 +14339,11 @@ utmiCampaign?: string } } /** - * 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. - * + * 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. + * * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. - * - * -> This request has a time out of 12 seconds. + * + * > This request has a time out of 12 seconds. */ "POST /api/checkout/pub/orderForm/:orderFormId/attachments/paymentData": { body: { @@ -14417,12 +14391,11 @@ hasDefaultBillingAddress?: boolean } } /** - * This endpoint is used for the merchant to add to the cart any relevant information that is related to the context of a specific order. - * + * This endpoint is used for the merchant to add to the cart any relevant information that is related to the context of a specific order. + * * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. - * - * -> This request has a time out of 12 seconds. + * + * > This request has a time out of 12 seconds. */ "POST /api/checkout/pub/orderForm/:orderFormId/attachments/merchantContextData": { body: { @@ -14445,13 +14418,11 @@ salesAssociateId?: string } /** * Your account may create `apps`, which contain custom fields, through the [Update orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pvt/configuration/orderForm) request. The values of these custom fields can then be updated by this request. - * - * -To do that, you need to inform the ID of the app you created with the configuration API (`appId`). - * - * -In the body of the request, for each field created in this app (`appFieldName`) you will inform a value (`appFieldValue`). - * + * + * To do that, you need to inform the ID of the app you created with the configuration API (`appId`). + * + * In the body of the request, for each field created in this app (`appFieldName`) you will inform a value (`appFieldValue`). + * * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. */ "PUT /api/checkout/pub/orderForm/:orderFormId/customData/:appId": { @@ -14465,13 +14436,11 @@ response: any } /** * Your account may create `apps`, which contain custom fields, through the [Update orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pvt/configuration/orderForm) request. The value of a specific custom field can then be updated by this request. - * - * -To do that, you need to inform in the URL the ID of the app you created with the configuration API (`appId`). - * - * -In the body of the request, you will inform the new value (`appFieldValue`, passed through the body) of the specific field created in this app (identified by the `appFieldName` parameter, passed through the URL). - * + * + * To do that, you need to inform in the URL the ID of the app you created with the configuration API (`appId`). + * + * In the body of the request, you will inform the new value (`appFieldValue`, passed through the body) of the specific field created in this app (identified by the `appFieldName` parameter, passed through the URL). + * * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. */ "PUT /api/checkout/pub/orderForm/:orderFormId/customData/:appId/:appFieldName": { @@ -14479,24 +14448,20 @@ body: SetsinglecustomfieldvalueRequest } /** * Your account may create `apps`, which contain custom fields, through the [Update orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pvt/configuration/orderForm) request. The value of a specific custom field can be removed by this request. - * - * -To do that, you need to inform in the URL the ID of the app you created with the configuration API (`appId`). - * - * -You also need to iform the specific field created in this app (identified by the `appFieldName` parameter, also passed through the URL) whose value you want to remove. + * + * To do that, you need to inform in the URL the ID of the app you created with the configuration API (`appId`). + * + * You also need to iform the specific field created in this app (identified by the `appFieldName` parameter, also passed through the URL) whose value you want to remove. */ "DELETE /api/checkout/pub/orderForm/:orderFormId/customData/:appId/:appFieldName": { } /** * Retrieves the settings that are currently applied to every orderForm in the account. - * - * -These settings are defined by the request [Update orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pvt/configuration/orderForm). - * - * -Always use this request to retrieve the current configuration before performing an update. By doing so you ensure that you are modifying only the properties you want. + * + * These settings are defined by the request [Update orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pvt/configuration/orderForm). + * + * Always use this request to retrieve the current configuration before performing an update. By doing so you ensure that you are modifying only the properties you want. */ "GET /api/checkout/pvt/configuration/orderForm": { response: { @@ -14581,15 +14546,11 @@ maxNumberOfWhiteLabelSellers?: (null | number) maskFirstPurchaseData?: (null | boolean) /** * 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/en/tutorial/using-recaptcha-at-checkout--18Te3oDd7f4qcjKu9jhNzP) - * - * -Possible values are: - * -- `"never"`: no purchases are validated with reCAPTCHA. - * -- `"always"`: every purchase is validated with reCAPTCHA. - * -- `"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. + * + * Possible values are: + * - `"never"`: no purchases are validated with reCAPTCHA. + * - `"always"`: every purchase is validated with reCAPTCHA. + * - `"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. */ recaptchaValidation?: string /** @@ -14608,41 +14569,37 @@ cartAgeToUseNewCardSeconds?: number } /** * Determines settings that will apply to every orderForm in the account. - * - * -For example, if you create an app using this request, every orderForm of this account will have the custom fields created though it. - * - * ->ℹ️ Always retrieve the current configuration before performing an update to ensure that you are modifying only the properties you want. Otherwise, old values can be overwritten. To retrieve the current configuration, use the request [Get orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#get-/api/checkout/pvt/configuration/orderForm). + * + * For example, if you create an app using this request, every orderForm of this account will have the custom fields created though it. + * + * >ℹ️ Always retrieve the current configuration before performing an update to ensure that you are modifying only the properties you want. Otherwise, old values can be overwritten. To retrieve the current configuration, use the request [Get orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#get-/api/checkout/pvt/configuration/orderForm). */ "POST /api/checkout/pvt/configuration/orderForm": { body: UpdateorderFormconfigurationRequest } /** * 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. - * - * -The default period for this window is of 2 days, but it can be configured by the request Update window to change seller. + * + * The default period for this window is of 2 days, but it can be configured by the request Update window to change seller. */ "GET /api/checkout/pvt/configuration/window-to-change-seller": { } /** * 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. - * - * -It is possible to check the current window using the request Get window to change seller. + * + * It is possible to check the current window using the request Get window to change seller. */ "POST /api/checkout/pvt/configuration/window-to-change-seller": { body: WaitingTime } /** - * This request removes all messages from the `messages` field of the orderForm , leaving it empty. - * - * You must send an empty JSON in the body of the request. - * - * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. - * + * This request removes all messages from the `messages` field of the orderForm , leaving it empty. + * + * You must send an empty JSON in the body of the request. + * + * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. + * * **Important**: **Request Body** must always be sent with empty value "{ }" in this endpoint. */ "POST /api/checkout/pub/orderForm/:orderFormId/messages/clear": { @@ -15732,15 +15689,13 @@ ascending?: boolean } } /** - * Retrieves possible amount of installments and respective values for a given cart with a given payment method. - * + * Retrieves possible amount of installments and respective values for a given cart with a given payment method. + * * The [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart. - * - * -This endpoint can be used to get the installment options for only one payment method at a time. - * - * -This endpoint should be called only after the selected `orderForm` already has a `paymentData`. + * + * This endpoint can be used to get the installment options for only one payment method at a time. + * + * This endpoint should be called only after the selected `orderForm` already has a `paymentData`. */ "GET /api/checkout/pub/orderForm/:orderFormId/installments": { searchParams: { @@ -15752,15 +15707,12 @@ paymentSystem: number } /** * Use this request to add coupons to a given shopping cart. - * - * -To add multiple coupons to the same cart, you need to: - * - * -1. Request the activation of this feature through the [Support VTEX](https://help.vtex.com/support) if this is the first time you perform this action on your store. - * -2. Submit all coupon codes in the same requisition separated by commas. E.g.: {"text": "freeshipping, discount10, holiday30"}. - * + * + * To add multiple coupons to the same cart, you need to: + * + * 1. Request the activation of this feature through the [Support VTEX](https://help.vtex.com/support) if this is the first time you perform this action on your store. + * 2. Submit all coupon codes in the same requisition separated by commas. E.g.: {"text": "freeshipping, discount10, holiday30"}. + * * For more information on multiple coupons, access the [coupons tutorial](https://help.vtex.com/en/tutorial/creating-a-coupon-beta--7lMk3MmhNp2IEccyGApxU). */ "POST /api/checkout/pub/orderForm/:orderFormId/coupons": { @@ -16851,9 +16803,8 @@ ascending?: boolean } /** * Retrieves information on pickup points close to a given location determined by geocoordinates or postal code. - * - * -The pickup points returned are not necessarily all active ones. Make sure to validate the information consumed by integrations. + * + * The pickup points returned are not necessarily all active ones. Make sure to validate the information consumed by integrations. */ "GET /api/checkout/pub/pickup-points": { searchParams: { @@ -16872,8 +16823,8 @@ countryCode?: string } } /** - * Retrieves address information for a given postal code and country. - * + * Retrieves address information for a given postal code and country. + * * This request can be used to implement auto complete functionality when a customer needs to fill in an address. */ "GET /api/checkout/pub/postal-code/:countryCode/:postalCode": { @@ -16881,9 +16832,8 @@ countryCode?: string } /** * This endpoint places an order from an existing `orderForm` object, meaning an existing cart. - * - * -After the creation of an order with this request, you have five minutes to send payment information and then request payment processing. + * + * After the creation of an order with this request, you have five minutes to send payment information and then request payment processing. */ "POST /api/checkout/pub/orderForm/:orderFormId/transaction": { body: { @@ -16908,8 +16858,8 @@ response: { } } /** - * Places order without having any prior cart information. This means all information on items, client, payment and shipping must be sent in the body. - * + * Places order without having any prior cart information. This means all information on items, client, payment and shipping must be sent in the body. + * * >⚠️ The authentication of this endpoint is required if you are creating an order with an item that has an attachment that creates a Subscription. For more information, access [Subscriptions API](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3). */ "PUT /api/checkout/pub/orders": { @@ -17026,12 +16976,10 @@ isGift?: boolean }[] /** * Customer's profile information. The `email` functions as a customer's ID. - * - * -For customers already in your database, sending only the email address is enough to register the order to the shopper’s existing account. - * - * -> 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. + * + * For customers already in your database, sending only the email address is enough to register the order to the shopper’s existing account. + * + * > 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. */ clientProfileData: { /** @@ -17089,9 +17037,8 @@ isCorporate?: boolean shippingData: { /** * Shipping address. - * - * -For 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. + * + * For 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. */ address?: { /** @@ -18445,26 +18392,21 @@ salesAssociateId?: string } /** * Order processing callback request, which is made after an order's payment is approved. - * - * -> This request has to be made within five minutes after the [Place order](https://developers.vtex.com/docs/api-reference/checkout-api#put-/api/checkout/pub/orders) or [Place order from existing cart](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForm/-orderFormId-/transaction) request has been made, or else, the order will not be processed. + * + * > This request has to be made within five minutes after the [Place order](https://developers.vtex.com/docs/api-reference/checkout-api#put-/api/checkout/pub/orders) or [Place order from existing cart](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForm/-orderFormId-/transaction) request has been made, or else, the order will not be processed. */ "POST /api/checkout/pub/gatewayCallback/:orderGroup": { } /** * Retrieves a list of sellers that cater to a specific region or address, according to your setup 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/docs/guides/region-v2-release). - * - * -To access the list of sellers, you must choose one of the following methods: - * - * -1. Send the identification of the list of sellers (`regionId`) as a path parameter through the URL. Or; - * -2. Send the `country` (3-digit ISO code) and at least one of the two values (`postal Code` or `geo Coordinates`) as query parameters through the URL. For this method, it is also allowed to send both values (`postalCode` or `geoCoordinates`) in the same request. - * - * -> The `regionId` and `country` parameters are indicated as required in this documentation. However, only one of them should be sent in the request according to one of the methods mentioned above. + * + * To access the list of sellers, you must choose one of the following methods: + * + * 1. Send the identification of the list of sellers (`regionId`) as a path parameter through the URL. Or; + * 2. Send the `country` (3-digit ISO code) and at least one of the two values (`postal Code` or `geo Coordinates`) as query parameters through the URL. For this method, it is also allowed to send both values (`postalCode` or `geoCoordinates`) in the same request. + * + * > The `regionId` and `country` parameters are indicated as required in this documentation. However, only one of them should be sent in the request according to one of the methods mentioned above. */ "GET /api/checkout/pub/regions/:regionId": { searchParams: { @@ -19757,8 +19699,8 @@ Name: string */ Text?: string /** - * Store Framework - Deprecated. - * Legacy CMS Portal - 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. + * Store Framework - Deprecated. + * Legacy CMS Portal - 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. * */ Keywords?: string @@ -19777,14 +19719,14 @@ AdWordsRemarketingCode?: string */ LomadeeCampaignCode?: string /** - * Store Framework - Deprecated - * Legacy CMS Portal - Value used to set the priority on the search result page. + * Store Framework - Deprecated + * Legacy CMS Portal - Value used to set the priority on the search result page. * */ Score?: number /** - * Store Framework - Deprecated. - * Legacy CMS Portal - Defines if the Brand appears in the Department Menu control (``). + * Store Framework - Deprecated. + * Legacy CMS Portal - Defines if the Brand appears in the Department Menu control (``). * */ MenuHome?: boolean @@ -19901,14 +19843,14 @@ Description: string */ IsStockKeepingUnit: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal - To allow the specification to be used as a facet (filter) on the search navigation bar. + * Store Framework - Deprecated. + * Legacy CMS Portal - To allow the specification to be used as a facet (filter) on the search navigation bar. * */ IsFilter: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal -If specification is visible on the product page. + * Store Framework - Deprecated. + * Legacy CMS Portal -If specification is visible on the product page. * */ IsOnProductDetails: boolean @@ -19922,14 +19864,14 @@ Position: number */ IsWizard: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal - To make the specification visible in the store's upper menu. + * Store Framework - Deprecated. + * Legacy CMS Portal - To make the specification visible in the store's upper menu. * */ IsTopMenuLinkActive: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal - To make the specification field clickable in the search navigation bar. + * Store Framework - Deprecated. + * Legacy CMS Portal - To make the specification field clickable in the search navigation bar. * */ IsSideMenuLinkActive: boolean @@ -19984,14 +19926,14 @@ Description: string */ IsStockKeepingUnit: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal - To allow the specification to be used as a facet (filter) on the search navigation bar. + * Store Framework - Deprecated. + * Legacy CMS Portal - To allow the specification to be used as a facet (filter) on the search navigation bar. * */ IsFilter: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal -If specification is visible on the product page. + * Store Framework - Deprecated. + * Legacy CMS Portal -If specification is visible on the product page. * */ IsOnProductDetails: boolean @@ -20005,14 +19947,14 @@ Position: number */ IsWizard: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal - To make the specification visible in the store's upper menu. + * Store Framework - Deprecated. + * Legacy CMS Portal - To make the specification visible in the store's upper menu. * */ IsTopMenuLinkActive: boolean /** - * Store Framework - Deprecated. - * Legacy CMS Portal - To make the specification field clickable in the search navigation bar. + * Store Framework - Deprecated. + * Legacy CMS Portal - To make the specification field clickable in the search navigation bar. * */ IsSideMenuLinkActive: boolean @@ -20481,15 +20423,11 @@ maxNumberOfWhiteLabelSellers?: number maskFirstPurchaseData?: boolean /** * 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) - * - * -Possible values are: - * -- `"never"`: no purchases are validated with reCAPTCHA. - * -- `"always"`: every purchase is validated with reCAPTCHA. - * -- `"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. + * + * Possible values are: + * - `"never"`: no purchases are validated with reCAPTCHA. + * - `"always"`: every purchase is validated with reCAPTCHA. + * - `"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. */ recaptchaValidation?: string /**